ConstructResource
Resource for handling constructs
The following resources are applicable:
/construct/delete/{constructId}/{idOrKeyname}
Mount Point: /CNPortletapp/rest/construct/delete/{constructId}/{idOrKeyname}
POST
Delete a part of a construct. Since the passed part ID is unique across all constructs, the construct doesn't have to be specified. This will not delete the datasource entries for an overview part, they are deleted when the construct is deleted.
Parameters
name | description | type | default |
---|---|---|---|
constructId | The ID of the construct where the part is in | path | |
idOrKeyname | The ID or the keyword of the part to delete. It will first try to delete by ID, if the value is numeric. | path |
Response Body
element: | genericResponse |
media types: | */* application/xml application/json |
Response object
/construct/list
Mount Point: /CNPortletapp/rest/construct/list
GET
Get the list of constructs that are used by the tags in the given page. This includes any constructs that exist in other nodes but are nevertheless used by tags in this page.
Parameters
name | description | type | default |
---|---|---|---|
skipCount | number of items to be skipped (paging) | query | 0 |
maxItems | maximum number of items to be returned (paging). -1 for getting all items. | query | -1 |
search | search string for filtering items | query | |
changeable | true to only get changeable constructs, false for only getting not changeable items. Leave empty to get all | query | |
pageId | ID of the page form which to get constructs. | query | |
nodeId | ID of the node for getting constructs linked to a node | query | |
category | ID of the category for filtering | query | |
sortby | attribute for sorting | query | |
sortorder | sort order | query | asc |
Response Body
element: | constructListResponse |
media types: | */* application/xml application/json |
list of constructs
/construct/load/{constructId}
Mount Point: /CNPortletapp/rest/construct/load/{constructId}
GET
Load the insertable construct and it's categories for a given constructId
Parameters
name | description | type | default |
---|---|---|---|
constructId | (no documentation provided) | path |
Response Body
element: | constructLoadResponse |
media types: | */* application/xml application/json |
(no documentation provided)