NodeResource
Resource for handling Nodes in GCN
The following resources are applicable:
- /node/create
- /node/features/{id}
- /node/features/activate/{id}
- /node/features/deactivate/{id}
- /node/features/set/{id}
- /node/getLanguages/{id}
- /node/load/{id}
- /node/save/{id}
/node/create
Mount Point: /CNPortletapp/rest/node/create
POST
Create a new node. See NodeResourceImpl#checkCreateRequest for a detailed list of constraints on the given request. In short:
- the node and hostname must be provided
- no other node with the same hostname and (binary) publish directory may exist
- if the Aloha editor is to be used, utf8 must be enabled
Request Body
| element: | nodeSaveRequest |
| media types: | */* application/xml application/json |
The request containing a REST model of the node to be created.
Response Body
| element: | nodeLoadResponse |
| media types: | */* application/xml application/json |
A node load response containing the values of the newly created node on success, or a response code indicating any errors on failure.
/node/features/{id}
Mount Point: /CNPortletapp/rest/node/features/{id}
GET
Load the activated features
Parameters
| name | description | type | default |
|---|---|---|---|
| id | id of the node | path |
Response Body
| element: | nodeFeatureResponse |
| media types: | */* application/xml application/json |
response containing the activated features
/node/features/activate/{id}
Mount Point: /CNPortletapp/rest/node/features/activate/{id}
POST
Activate the given list of features (features not listed will not be changed)
Parameters
| name | description | type | default |
|---|---|---|---|
| id | id of the node. This can be either the localid or the globalid | path |
Request Body
| element: | nodeFeatureRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | genericResponse |
| media types: | */* application/xml application/json |
generic response
/node/features/deactivate/{id}
Mount Point: /CNPortletapp/rest/node/features/deactivate/{id}
POST
Deactivate the given list of features (features not listed will not be changed)
Parameters
| name | description | type | default |
|---|---|---|---|
| id | id of the node. This can be either the localid or the globalid | path |
Request Body
| element: | nodeFeatureRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | genericResponse |
| media types: | */* application/xml application/json |
generic response
/node/features/set/{id}
Mount Point: /CNPortletapp/rest/node/features/set/{id}
POST
Set the given list of features. Exactly the listed features will be activated, all other will be deactivated
Parameters
| name | description | type | default |
|---|---|---|---|
| id | id of the node. This can be either the localid or the globalid | path |
Request Body
| element: | nodeFeatureRequest |
| media types: | */* application/xml application/json |
(no documentation provided)
Response Body
| element: | genericResponse |
| media types: | */* application/xml application/json |
generic response
/node/getLanguages/{id}
Mount Point: /CNPortletapp/rest/node/getLanguages/{id}
GET
Get the ordered list of languages of the node
Parameters
| name | description | type | default |
|---|---|---|---|
| id | node id | path |
Response Body
| element: | languageListResponse |
| media types: | */* application/xml application/json |
ordered list of languages
/node/load/{id}
Mount Point: /CNPortletapp/rest/node/load/{id}
GET
Load a single node
Parameters
| name | description | type | default |
|---|---|---|---|
| id | id of the node to load. This can be either the localid or a globalid | path | |
| update | 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. | query | false |
Response Body
| element: | nodeLoadResponse |
| media types: | */* application/xml application/json |
response containing the node to load
/node/save/{id}
Mount Point: /CNPortletapp/rest/node/save/{id}
POST
Saves the values specified in the request to the node. See NodeResourceImpl#checkRequestConsistency for a detailed list of constraints on the request. In short:
- any folder id that is given must be valid
- no other node with the same hostname and (binary) publish directory may exist
- if the Aloha editor is to be used, utf8 must be enabled
Parameters
| name | description | type | default |
|---|---|---|---|
| id | (no documentation provided) | path |
Request Body
| element: | nodeSaveRequest |
| media types: | */* application/xml application/json |
The request containing the fields to be updated in the node.
Response Body
| element: | genericResponse |
| media types: | */* application/xml application/json |
A generic response indicating the success or failure of the operation.