@Path(value="node") public interface NodeResource extends AuthenticatedResource
Modifier and Type | Method and Description |
---|---|
GenericResponse |
activateFeatures(String nodeId,
NodeFeatureRequest request)
Activate the given list of features (features not listed will not be changed)
|
GenericResponse |
addConstruct(String nodeId,
String constructId)
Add a construct to a node.
|
GenericResponse |
addTemplate(String nodeId,
String templateId)
Add a template to a node.
|
NodeLoadResponse |
create(NodeSaveRequest request)
Create a new node.
|
GenericResponse |
deactivateFeatures(String nodeId,
NodeFeatureRequest request)
Deactivate the given list of features (features not listed will not be changed)
|
PagedConstructListResponse |
getConstructs(String nodeId,
FilterParameterBean filter,
SortParameterBean sorting,
PagingParameterBean paging)
Get the constructs assigned to this node
|
NodeFeatureResponse |
getFeatures(String nodeId)
Load the activated features
|
PagedTemplateListResponse |
getTemplates(String nodeId,
FilterParameterBean filter,
SortParameterBean sorting,
PagingParameterBean paging)
Get the templates assigned to this node
|
LanguageListResponse |
languages(String nodeId)
Get the ordered list of languages of the node
|
NodeLoadResponse |
load(String nodeId,
boolean update)
Load a single node
|
GenericResponse |
removeConstruct(String nodeId,
String constructId)
Remove a construct from a node.
|
GenericResponse |
removeTemplate(String nodeId,
String templateId)
Remove a template from a node.
|
GenericResponse |
save(String nodeId,
NodeSaveRequest request)
Saves the values specified in the request to the
node.
|
GenericResponse |
setFeatures(String nodeId,
NodeFeatureRequest request)
Set the given list of features.
|
setSessionId
@POST @Path(value="/create") NodeLoadResponse create(NodeSaveRequest request)
NodeResourceImpl#checkCreateRequest
for a detailed list of
constraints on the given request. In short:
request
- The request containing a REST model of
the node to be created.@POST @Path(value="/save/{id}") GenericResponse save(@PathParam(value="id") String nodeId, NodeSaveRequest request)
NodeResourceImpl#checkRequestConsistency
for a detailed
list of constraints on the request. In short:
id
- The id of the node to save.request
- The request containing the fields
to be updated in the node.@GET @Path(value="/load/{id}") NodeLoadResponse load(@PathParam(value="id") String nodeId, @DefaultValue(value="false") @QueryParam(value="update") boolean update)
nodeId
- id of the node to load. This can be either the localid or a globalidupdate
- true when the folder is fetched for updating. Currently, nodes
cannot be locked in the backend, but it is still recommended
to set this parameter to true when the node shall be modified.@GET @Path(value="/getLanguages/{id}") LanguageListResponse languages(@PathParam(value="id") String nodeId) throws Exception
nodeId
- node idException
@GET @Path(value="/features/{id}") NodeFeatureResponse getFeatures(@PathParam(value="id") String nodeId)
nodeId
- id of the node@POST @Path(value="/features/activate/{id}") GenericResponse activateFeatures(@PathParam(value="id") String nodeId, NodeFeatureRequest request)
nodeId
- id of the node. This can be either the localid or the globalid@POST @Path(value="/features/deactivate/{id}") GenericResponse deactivateFeatures(@PathParam(value="id") String nodeId, NodeFeatureRequest request)
nodeId
- id of the node. This can be either the localid or the globalid@POST @Path(value="/features/set/{id}") GenericResponse setFeatures(@PathParam(value="id") String nodeId, NodeFeatureRequest request)
nodeId
- id of the node. This can be either the localid or the globalid@GET @Path(value="/{nodeId}/templates") PagedTemplateListResponse getTemplates(@PathParam(value="nodeId") String nodeId, @BeanParam FilterParameterBean filter, @BeanParam SortParameterBean sorting, @BeanParam PagingParameterBean paging) throws Exception
nodeId
- Node ID (local or global)filter
- filter parameterssorting
- sorting parameterspaging
- paging parametersException
@PUT @Path(value="/{nodeId}/templates/{templateId}") GenericResponse addTemplate(@PathParam(value="nodeId") String nodeId, @PathParam(value="templateId") String templateId) throws Exception
nodeId
- Node ID (local or global)templateId
- Template ID (local or global)Exception
@DELETE @Path(value="/{nodeId}/templates/{templateId}") GenericResponse removeTemplate(@PathParam(value="nodeId") String nodeId, @PathParam(value="templateId") String templateId) throws Exception
nodeId
- Node ID (local or global)templateId
- Template ID (local or global)Exception
@GET @Path(value="/{nodeId}/constructs") PagedConstructListResponse getConstructs(@PathParam(value="nodeId") String nodeId, @BeanParam FilterParameterBean filter, @BeanParam SortParameterBean sorting, @BeanParam PagingParameterBean paging) throws Exception
nodeId
- Node ID (local or global)filter
- filter parameterssorting
- sorting parameterspaging
- paging parametersException
@PUT @Path(value="/{nodeId}/constructs/{constructId}") GenericResponse addConstruct(@PathParam(value="nodeId") String nodeId, @PathParam(value="constructId") String constructId) throws Exception
nodeId
- Node ID (local or global)constructId
- Construct ID (local or global)Exception
@DELETE @Path(value="/{nodeId}/constructs/{constructId}") GenericResponse removeConstruct(@PathParam(value="nodeId") String nodeId, @PathParam(value="constructId") String constructId) throws Exception
nodeId
- Node ID (local or global)constructId
- Construct ID (local or global)Exception
Copyright © 2017 Gentics Software. All rights reserved.