Interface ObjectPropertyResource


  • @Path("/objectproperty")
    public interface ObjectPropertyResource
    Resource for management of object property definitions
    • Method Detail

      • list

        @GET
        ObjectPropertyListResponse list​(@BeanParam
                                        SortParameterBean sorting,
                                        @BeanParam
                                        FilterParameterBean filter,
                                        @BeanParam
                                        PagingParameterBean paging,
                                        @BeanParam
                                        ObjectPropertyParameterBean typeFilter,
                                        @BeanParam
                                        EmbedParameterBean embed)
                                 throws Exception
        List object properties.
        The result can be filtered by
        • id
        • globalId
        • name
        • description
        • keyword
        and sorted by
        • id
        • globalId
        • name
        • description
        • keyword
        • type
        • required
        • inheritable
        • syncContentset
        • syncChannelset
        • syncVariants
        • construct.name
        • category.name
        Parameters:
        sorting - sort parameters
        filter - filter parameter
        paging - paging parameters
        typeFilter - type filter parameters
        embed - optionally embed the referenced objects (category, construct)
        Returns:
        response containing a list of object properties
        Throws:
        Exception
      • create

        @POST
        ObjectPropertyLoadResponse create​(ObjectProperty objectProperty)
                                   throws Exception
        Create a new construct category.

        If any of the following requirements are not met, the operation will fail with a 400 Bad Request status code:

        • The keyword field is missing or empty
        • The keyword field contains characters other than letters (A-Z and a-z), digits (0-9), minus ('-') and underscore ('_')
        • The type field is missing

        Parameters:
        objectProperty - new object property REST model
        Returns:
        response containing the object property
        Throws:
        Exception
      • get

        @GET
        @Path("{id}")
        ObjectPropertyLoadResponse get​(@PathParam("id")
                                       String objectPropertyId,
                                       @BeanParam
                                       EmbedParameterBean embed)
                                throws Exception
        Load the object property by its ID
        Parameters:
        objectPropertyId - object property ID
        embed - optionally embed the referenced objects (category, construct)
        Returns:
        response containing the updated object property
        Throws:
        Exception
      • delete

        @DELETE
        @Path("{id}")
        GenericResponse delete​(@PathParam("id")
                               String objectPropertyId,
                               @QueryParam("foregroundTime") @DefaultValue("-1")
                               int foregroundTime)
                        throws Exception
        Delete the object property by its ID
        Parameters:
        objectPropertyId - object property ID
        Returns:
        general success response
        Throws:
        Exception
      • deleteCategory

        @DELETE
        @Path("/category/{id}")
        GenericResponse deleteCategory​(@PathParam("id")
                                       String objectPropertyCategoryId)
                                throws Exception
        Delete the object property category by its ID
        Parameters:
        objectPropertyCategoryId - category ID
        Returns:
        general success response
        Throws:
        Exception
      • link

        @POST
        @Path("/link/nodes")
        GenericResponse link​(BulkLinkUpdateRequest request)
                      throws Exception
        Link a set of object property definitions to the selected nodes
        Parameters:
        request - POST body with source + target IDs
        Returns:
        general success response
        Throws:
        Exception
      • unlink

        @POST
        @Path("/unlink/nodes")
        GenericResponse unlink​(BulkLinkUpdateRequest request)
                        throws Exception
        Unlink a set of object property definitions from the selected nodes
        Parameters:
        request - POST body with source + target IDs
        Returns:
        general success response
        Throws:
        Exception
      • listObjectPropertyConstructs

        @GET
        @Path("/{id}/constructs")
        ConstructListResponse listObjectPropertyConstructs​(@PathParam("id")
                                                           String objectPropertyId)
                                                    throws Exception
        Return a list of constructs, utilizing the given Object Property
        Parameters:
        objectPropertyId -
        Returns:
        Throws:
        Exception
      • listObjectPropertyNodes

        @GET
        @Path("/{id}/nodes")
        NodeList listObjectPropertyNodes​(@PathParam("id")
                                         String objectPropertyId)
                                  throws Exception
        Return a list of nodes, linked to the the given Object Property
        Parameters:
        objectPropertyId -
        Returns:
        Throws:
        Exception