com.gentics.contentnode.rest.resource

Interface ObjectPropertyResource

@Path(value="/objectproperty")
public interface ObjectPropertyResource

Resource for management of object property definitions

Method Summary

Modifier and Type	Method and Description
ObjectPropertyLoadResponse	create(ObjectProperty objectProperty) Create a new construct category.
ObjectPropertyCategoryLoadResponse	createCategory(ObjectPropertyCategory category) Create a new object property category
GenericResponse	delete(String objectPropertyId) Delete the object property by its ID
GenericResponse	deleteCategory(String objectPropertyCategoryId) Delete the object property category by its ID
ObjectPropertyLoadResponse	get(String objectPropertyId) Load the object property by its ID
ObjectPropertyCategoryLoadResponse	getCategory(String categoryId) Load the object property category by its ID
ImplementationHashResponse	implementationHash(String id) Get the implementation hash for an object property
GenericResponse	link(BulkLinkUpdateRequest request) Link a set of object property definitions to the selected nodes
ObjectPropertyListResponse	list(SortParameterBean sorting, FilterParameterBean filter, PagingParameterBean paging, ObjectPropertyParameterBean typeFilter, EmbedParameterBean embed) 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
ObjectPropertyCategoryListResponse	listCategories(SortParameterBean sorting, FilterParameterBean filter, PagingParameterBean paging, EmbedParameterBean embed) List all object property categories. The result can be filtered by id globalId name sortOrder and sorted by id globalId name sortOrder
ConstructListResponse	listObjectPropertyConstructs(String objectPropertyId) Return a list of constructs, utilizing the given Object Property
NodeList	listObjectPropertyNodes(String objectPropertyId) Return a list of nodes, linked to the the given Object Property
GenericResponse	unlink(BulkLinkUpdateRequest request) Unlink a set of object property definitions from the selected nodes
ObjectPropertyLoadResponse	update(String objectPropertyId, ObjectProperty objectProperty) Edit the object property by its ID
ObjectPropertyCategoryLoadResponse	updateCategory(String objectPropertyCategoryId, ObjectPropertyCategory category) Edit the object property category by its ID

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 - embed parameters

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(value="{id}")
ObjectPropertyLoadResponse get(@PathParam(value="id")
                                                         String objectPropertyId)
                                                  throws Exception

Load the object property by its ID

Parameters:

objectPropertyId - object property ID

Returns:

response containing the updated object property

Throws:

Exception

implementationHash

@GET
 @Path(value="/{id}/hash")
ImplementationHashResponse implementationHash(@PathParam(value="id")
                                                                              String id)
                                                                       throws Exception

Get the implementation hash for an object property

Parameters:

id - object property ID

Returns:

response with implementation hash

Throws:

Exception

update

@PUT
 @Path(value="{id}")
ObjectPropertyLoadResponse update(@PathParam(value="id")
                                                            String objectPropertyId,
                                                            ObjectProperty objectProperty)
                                                     throws Exception

Edit the object property by its ID

Parameters:

objectPropertyId - object property ID

Returns:

response containing the updated object property

Throws:

Exception

delete

@DELETE
 @Path(value="{id}")
GenericResponse delete(@PathParam(value="id")
                                                    String objectPropertyId)
                                             throws Exception

Delete the object property by its ID

Parameters:

objectPropertyId - object property ID

Returns:

general success response

Throws:

Exception

createCategory

@POST
 @Path(value="/category")
ObjectPropertyCategoryLoadResponse createCategory(ObjectPropertyCategory category)
                                                                           throws Exception

Create a new object property category

Parameters:

category - new category REST model

Returns:

response containing the created category

Throws:

Exception

getCategory

@GET
 @Path(value="/category/{id}")
ObjectPropertyCategoryLoadResponse getCategory(@PathParam(value="id")
                                                                                   String categoryId)
                                                                            throws Exception

Load the object property category by its ID

Parameters:

categoryId - category ID

Returns:

response containing the category

Throws:

Exception

updateCategory

@PUT
 @Path(value="/category/{id}")
ObjectPropertyCategoryLoadResponse updateCategory(@PathParam(value="id")
                                                                                      String objectPropertyCategoryId,
                                                                                      ObjectPropertyCategory category)
                                                                               throws Exception

Edit the object property category by its ID

Parameters:

objectPropertyCategoryId - category ID

Returns:

response containing the updated object property category

Throws:

Exception

deleteCategory

@DELETE
 @Path(value="/category/{id}")
GenericResponse deleteCategory(@PathParam(value="id")
                                                                      String objectPropertyCategoryId)
                                                               throws Exception

Delete the object property category by its ID

Parameters:

objectPropertyCategoryId - category ID

Returns:

general success response

Throws:

Exception

listCategories

@GET
 @Path(value="/category")
ObjectPropertyCategoryListResponse listCategories(@BeanParam
                                                                                 SortParameterBean sorting,
                                                                                 @BeanParam
                                                                                 FilterParameterBean filter,
                                                                                 @BeanParam
                                                                                 PagingParameterBean paging,
                                                                                 @BeanParam
                                                                                 EmbedParameterBean embed)
                                                                          throws Exception

List all object property categories.
The result can be filtered by

• id
• globalId
• name
• sortOrder

and sorted by

• id
• globalId
• name
• sortOrder

Returns:

response with list

Throws:

Exception

link

@POST
 @Path(value="/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(value="/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(value="/{id}/constructs")
ConstructListResponse listObjectPropertyConstructs(@PathParam(value="id")
                                                                                         String objectPropertyId)
                                                                                  throws Exception

Return a list of constructs, utilizing the given Object Property

Parameters:

objectPropertyId -

Returns:

Throws:

Exception

listObjectPropertyNodes

@GET
 @Path(value="/{id}/nodes")
NodeList listObjectPropertyNodes(@PathParam(value="id")
                                                                  String objectPropertyId)
                                                           throws Exception

Return a list of nodes, linked to the the given Object Property

Parameters:

objectPropertyId -

Returns:

Throws:

Exception