Package com.logicaldoc.webservice.rest

Interface DocumentMetadataService

  • All Known Implementing Classes:
    RestDocumentMetadataService, RestDocumentMetadataSwagger
    @Consumes("application/json")
@Produces("application/json")
@Path("/")
public interface DocumentMetadataService
    Document Metadata Service definition interface for REST. Alessandro Gasparini - LogicalDOC
    Since:
    8.4.2

    • Method Detail

      • addAttributeOption

        @POST
@Consumes("application/x-www-form-urlencoded")
@Path("/addAttributeOption")
void addAttributeOption​(@FormParam("setId")
                        long setId,
                        @FormParam("attribute")
                        String attribute,
                        @FormParam("option")
                        WSAttributeOption option)
                 throws Exception
        Add a new option for the given attribute
        Parameters:
        setId - Attribute set ID
        attribute - Attribute name
        option - Attribute option
        Throws:
        Exception - error in the server application

      • setAttributeOptions

        @PUT
@Path("/setAttributeOptions")
void setAttributeOptions​(@QueryParam("setId")
                         long setId,
                         @QueryParam("attribute")
                         String attribute,
                         @QueryParam("options")
                         WSAttributeOption[] options)
                  throws Exception
        Saves the options for the given attribute
        Parameters:
        setId - The attribute set's id
        attribute - The attribute's name
        options - The attribute's options
        Throws:
        Exception - error in the server application

      • setAttributeOptionsPOST

        @POST
@Consumes("multipart/form-data")
@Path("/setAttributeOptionsPOST")
void setAttributeOptionsPOST​(Long setId,
                             String attribute,
                             WSAttributeOption[] options)
                      throws Exception
        Saves the options for the given attribute with a POST method. This is useful for very large lists of values
        Parameters:
        setId - The attribute set's id
        attribute - The attribute's name
        options - The attribute's options
        Throws:
        Exception - error in the server application

      • storeAttributeSet

        @POST
@Path("/storeAttributeSet")
long storeAttributeSet​(WSAttributeSet attributeSet)
                throws Exception
        Create/Update an attribute set. You can completely customize the attribute set through a value object containing the attribute set's metadata.
        Parameters:
        attributeSet - set's value object containing the attribute set's metadata
        Returns:
        The ID of the new attribute set
        Throws:
        Exception - error in the server application

      • storeTemplate

        @POST
@Path("/storeTemplate")
long storeTemplate​(WSTemplate template)
            throws Exception
        Create/Update a template. You can completely customize the template through a value object.
        Parameters:
        template - value object containing the template's metadata
        Returns:
        The ID of the new template
        Throws:
        Exception - error in the server application

      • getAttributeSetById

        @GET
@Path("/getAttributeSetById")
WSAttributeSet getAttributeSetById​(@QueryParam("setId")
                                   long setId)
                            throws Exception
        Gets attribute set's metadata
        Parameters:
        setId - The attribute set's id
        Returns:
        A value object containing the attribute set's metadata
        Throws:
        Exception - error in the server application

      • getAttributeSet

        @GET
@Path("/getAttributeSet")
WSAttributeSet getAttributeSet​(@QueryParam("name")
                               String name)
                        throws Exception
        Gets attribute set's metadata
        Parameters:
        name - The attribute set's name
        Returns:
        A value object containing the attribute set's metadata
        Throws:
        Exception - error in the server application

      • getTemplate

        @GET
@Path("/getTemplate")
WSTemplate getTemplate​(@QueryParam("name")
                       String name)
                throws Exception
        Gets template's metadata
        Parameters:
        name - The template's name
        Returns:
        A value object containing the template's metadata.
        Throws:
        Exception - error in the server application

      • getTemplateById

        @GET
@Path("/getTemplateById")
WSTemplate getTemplateById​(@QueryParam("templateId")
                           long templateId)
                    throws Exception
        Gets template's metadata
        Parameters:
        templateId - The template's id
        Returns:
        A value object containing the template's metadata
        Throws:
        Exception - error in the server application

      • getAttributeOptions

        @GET
@Path("/getAttributeOptions")
String[] getAttributeOptions​(@QueryParam("setId")
                             long setId,
                             @QueryParam("attribute")
                             String attribute)
                      throws Exception
        Retrieves the options for the given attribute
        Parameters:
        setId - The attribute set's id
        attribute - The attribute's name
        Returns:
        the list of all the attribute's options
        Throws:
        Exception - error in the server application

      • listAttributeSets

        @GET
@Path("/listAttributeSets")
WSAttributeSet[] listAttributeSets()
                            throws Exception
        Gets metadata of all existing attribute sets.
        Returns:
        The list of all attribute sets
        Throws:
        Exception - error in the server application

      • deleteAttributeSet

        @DELETE
@Path("/deleteAttributeSet")
void deleteAttributeSet​(@QueryParam("setId")
                        long setId)
                 throws Exception
        Deletes an existing attribute set with the given identifier.
        Parameters:
        setId - The attribute set's id
        Throws:
        Exception - error in the server application

      • deleteTemplate

        @DELETE
@Path("/deleteTemplate")
void deleteTemplate​(@QueryParam("templateId")
                    long templateId)
             throws Exception
        Deletes an existing template with the given identifier
        Parameters:
        templateId - The template's id
        Throws:
        Exception - error in the server application

      • listTemplates

        @GET
@Path("/listTemplates")
WSTemplate[] listTemplates()
                    throws Exception
        Gets metadata of all existing templates.
        Returns:
        The list of all templates
        Throws:
        Exception - error in the server application