Interface ObjectPropertyResource
-
@Path("/objectproperty") public interface ObjectPropertyResource
Resource for management of object property definitions
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ObjectPropertyLoadResponse
create(ObjectProperty objectProperty)
Create a new construct category.ObjectPropertyCategoryLoadResponse
createCategory(ObjectPropertyCategory category)
Create a new object property categoryGenericResponse
delete(String objectPropertyId, int foregroundTime)
Delete the object property by its IDGenericResponse
deleteCategory(String objectPropertyCategoryId)
Delete the object property category by its IDObjectPropertyLoadResponse
get(String objectPropertyId, EmbedParameterBean embed)
Load the object property by its IDObjectPropertyCategoryLoadResponse
getCategory(String categoryId)
Load the object property category by its IDGenericResponse
link(BulkLinkUpdateRequest request)
Link a set of object property definitions to the selected nodesObjectPropertyListResponse
list(SortParameterBean sorting, FilterParameterBean filter, PagingParameterBean paging, ObjectPropertyParameterBean typeFilter, EmbedParameterBean embed)
List object properties.
The result can be filtered byid
globalId
name
description
keyword
and sorted byid
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 byid
globalId
name
sortOrder
and sorted byid
globalId
name
sortOrder
ConstructListResponse
listObjectPropertyConstructs(String objectPropertyId)
Return a list of constructs, utilizing the given Object PropertyNodeList
listObjectPropertyNodes(String objectPropertyId)
Return a list of nodes, linked to the the given Object PropertyGenericResponse
unlink(BulkLinkUpdateRequest request)
Unlink a set of object property definitions from the selected nodesObjectPropertyLoadResponse
update(String objectPropertyId, ObjectProperty objectProperty)
Edit the object property by its IDObjectPropertyCategoryLoadResponse
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 byid
globalId
name
description
keyword
id
globalId
name
description
keyword
type
required
inheritable
syncContentset
syncChannelset
syncVariants
construct.name
category.name
- Parameters:
sorting
- sort parametersfilter
- filter parameterpaging
- paging parameterstypeFilter
- type filter parametersembed
- 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
- The
-
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 IDembed
- optionally embed the referenced objects (category, construct)- Returns:
- response containing the updated object property
- Throws:
Exception
-
update
@PUT @Path("{id}") ObjectPropertyLoadResponse update(@PathParam("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("{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
-
createCategory
@POST @Path("/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("/category/{id}") ObjectPropertyCategoryLoadResponse getCategory(@PathParam("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("/category/{id}") ObjectPropertyCategoryLoadResponse updateCategory(@PathParam("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("/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
-
listCategories
@GET @Path("/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 byid
globalId
name
sortOrder
id
globalId
name
sortOrder
- Returns:
- response with list
- 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
-
-