Resource for handling constructs
Get the list of constructs
name | type | description | default | constraints | multivalued |
---|---|---|---|---|---|
category | query | ID of the category for filtering. | int | no | |
changeable | query | True to only get changeable constructs, false for only getting not changeable items. Leave empty to get all. | boolean | no | |
nodeId | query | ID of the node for getting constructs linked to a node. | int | no | |
page | query | Returned page, if paging is used. Paging starts with 1 |
1 | int | no |
pageId | query | ID of the page form which to get constructs. | int | no | |
pageSize | query | Page size for paging. If this is set to -1 no paging is used (all matching items are returned).
Setting this to 0 will return no items. |
-1 | int | no |
partTypeId | query | IDs of part types for filtering. | int | yes | |
q | query | Query string for filtering | no | ||
sort | query | Comma separated list of sorted attributes.
Each attribute name may be prefixed with + for sorting in ascending order or - for sorting in descending order |
name | no |
code | condition |
---|---|
200 | The list of constructs is returned. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | PagedConstructListResponse (JSON) | response containing a list of constructs |
application/xml | (custom) |
GET /construct Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"items" : [ { }, { } ],
"hasMoreItems" : true,
"numItems" : 12345,
"perms" : {
"property1" : [ "delete", "edit" ],
"property2" : [ "publish", "view" ]
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
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.
name | type | description | default | constraints | multivalued |
---|---|---|---|---|---|
category | query | ID of the category for filtering | int | no | |
changeable | query | true to only get changeable constructs, false for only getting not changeable items. Leave empty to get all | boolean | no | |
maxItems | query | maximum number of items to be returned (paging). -1 for getting all items. | -1 | int | no |
nodeId | query | ID of the node for getting constructs linked to a node | int | no | |
pageId | query | ID of the page form which to get constructs. | int | no | |
partTypeId | query | IDs of part types for filtering | int | yes | |
search | query | search string for filtering items | no | ||
skipCount | query | number of items to be skipped (paging) | 0 | int | no |
sortby | query | attribute for sorting | "category" or "description" or "keyword" or "name" | no | |
sortorder | query | sort order | asc | "ASC" or "DESC" or "NONE" or "asc" or "desc" or "none" | no |
code | condition |
---|---|
200 | The list of constructs is returned. |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | ConstructListResponse (JSON) | list of constructs |
application/xml | (custom) |
GET /construct/list Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"constructs" : [ {
"keyword" : "...",
"mayBeSubtag" : true,
"mayContainSubtags" : true,
"id" : 12345,
"globalId" : "...",
"name" : "...",
"description" : "...",
"icon" : "...",
"creator" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"cdate" : 12345,
"editor" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"edate" : 12345,
"editdo" : 12345,
"category" : "...",
"categorySortorder" : 12345,
"newEditor" : true,
"externalEditorUrl" : "...",
"parts" : [ {
"name" : "...",
"keyword" : "...",
"hidden" : true,
"editable" : true,
"liveEditable" : true,
"mandatory" : true,
"type" : "NODE",
"typeId" : 12345,
"id" : 12345,
"globalId" : "...",
"defaultProperty" : { },
"regex" : { },
"hideInEditor" : true,
"externalEditorUrl" : "...",
"options" : [ { }, { } ],
"overviewSettings" : { },
"selectSettings" : { }
}, {
"name" : "...",
"keyword" : "...",
"hidden" : true,
"editable" : true,
"liveEditable" : true,
"mandatory" : true,
"type" : "PAGE",
"typeId" : 12345,
"id" : 12345,
"globalId" : "...",
"defaultProperty" : { },
"regex" : { },
"hideInEditor" : true,
"externalEditorUrl" : "...",
"options" : [ { }, { } ],
"overviewSettings" : { },
"selectSettings" : { }
} ],
"visibleInMenu" : true
}, {
"keyword" : "...",
"mayBeSubtag" : true,
"mayContainSubtags" : true,
"id" : 12345,
"globalId" : "...",
"name" : "...",
"description" : "...",
"icon" : "...",
"creator" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"cdate" : 12345,
"editor" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"edate" : 12345,
"editdo" : 12345,
"category" : "...",
"categorySortorder" : 12345,
"newEditor" : true,
"externalEditorUrl" : "...",
"parts" : [ {
"name" : "...",
"keyword" : "...",
"hidden" : true,
"editable" : true,
"liveEditable" : true,
"mandatory" : true,
"type" : "SELECT",
"typeId" : 12345,
"id" : 12345,
"globalId" : "...",
"defaultProperty" : { },
"regex" : { },
"hideInEditor" : true,
"externalEditorUrl" : "...",
"options" : [ { }, { } ],
"overviewSettings" : { },
"selectSettings" : { }
}, {
"name" : "...",
"keyword" : "...",
"hidden" : true,
"editable" : true,
"liveEditable" : true,
"mandatory" : true,
"type" : "BOOLEAN",
"typeId" : 12345,
"id" : 12345,
"globalId" : "...",
"defaultProperty" : { },
"regex" : { },
"hideInEditor" : true,
"externalEditorUrl" : "...",
"options" : [ { }, { } ],
"overviewSettings" : { },
"selectSettings" : { }
} ],
"visibleInMenu" : true
} ],
"hasMoreItems" : true,
"numItems" : 12345,
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
Load the insertable construct and it's categories for a given constructId
name | type | description | constraints |
---|---|---|---|
constructId | path | construct ID | int |
code | condition |
---|---|
200 | The list of constructs is returned. |
404 | The construct with ID {constructId} does not exist |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | ConstructLoadResponse (JSON) | response containing the construct |
application/xml | (custom) |
GET /construct/load/{constructId} Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"construct" : {
"keyword" : "...",
"mayBeSubtag" : true,
"mayContainSubtags" : true,
"id" : 12345,
"globalId" : "...",
"name" : "...",
"description" : "...",
"icon" : "...",
"creator" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"cdate" : 12345,
"editor" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"edate" : 12345,
"editdo" : 12345,
"category" : "...",
"categorySortorder" : 12345,
"newEditor" : true,
"externalEditorUrl" : "...",
"parts" : [ {
"name" : "...",
"keyword" : "...",
"hidden" : true,
"editable" : true,
"liveEditable" : true,
"mandatory" : true,
"type" : "BREADCRUMB",
"typeId" : 12345,
"id" : 12345,
"globalId" : "...",
"defaultProperty" : { },
"regex" : { },
"hideInEditor" : true,
"externalEditorUrl" : "...",
"options" : [ { }, { } ],
"overviewSettings" : { },
"selectSettings" : { }
}, {
"name" : "...",
"keyword" : "...",
"hidden" : true,
"editable" : true,
"liveEditable" : true,
"mandatory" : true,
"type" : "NAVIGATION",
"typeId" : 12345,
"id" : 12345,
"globalId" : "...",
"defaultProperty" : { },
"regex" : { },
"hideInEditor" : true,
"externalEditorUrl" : "...",
"options" : [ { }, { } ],
"overviewSettings" : { },
"selectSettings" : { }
} ],
"visibleInMenu" : true
},
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}
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.
name | type | description |
---|---|---|
constructId | path | The ID of the construct where the part is in |
idOrKeyname | path | The ID or the keyword of the part to delete. It will first try to delete by ID, if the value is numeric. |
code | condition |
---|---|
200 | The part has been deleted |
401 | No valid sid and session secret cookie were provided. |
403 | User has insufficient permissions. |
media type | data type | description |
---|---|---|
application/json | GenericResponse (JSON) | Response object |
application/xml | (custom) |
POST /construct/delete/{constructId}/{idOrKeyname} Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
{
"messages" : [ { }, { } ],
"responseInfo" : {
"responseCode" : "OK",
"responseMessage" : "...",
"property" : "..."
}
}