Resource for handling constructs
Load the insertable construct and it's categories for a given constructId
name | type | description | constraints |
---|---|---|---|
constructId | path | int |
media type | data type |
---|---|
application/json | ConstructLoadResponse (JSON) |
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,
"parts" : [ {
"name" : "...",
"keyword" : "...",
"hidden" : true,
"editable" : true,
"liveEditable" : true,
"type" : "DATASOURCE",
"id" : 12345,
"globalId" : "...",
"defaultProperty" : { }
}, {
"name" : "...",
"keyword" : "...",
"hidden" : true,
"editable" : true,
"liveEditable" : true,
"type" : "UNORDEREDLIST",
"id" : 12345,
"globalId" : "...",
"defaultProperty" : { }
} ],
"visibleInMenu" : true
},
"messages" : [ {
"fieldName" : "...",
"message" : "...",
"type" : "INFO",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
}, {
"fieldName" : "...",
"message" : "...",
"type" : "SUCCESS",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
} ],
"responseInfo" : {
"responseCode" : "NOTLICENSED",
"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 |
---|---|---|---|---|
category | query | ID of the category for filtering | int | |
changeable | query | true to only get changeable constructs, false for only getting not changeable items. Leave empty to get all | boolean | |
maxItems | query | maximum number of items to be returned (paging). -1 for getting all items. | -1 | int |
nodeId | query | ID of the node for getting constructs linked to a node | int | |
pageId | query | ID of the page form which to get constructs. | int | |
search | query | search string for filtering items | ||
skipCount | query | number of items to be skipped (paging) | 0 | int |
sortby | query | attribute for sorting | "category" or "description" or "keyword" or "name" | |
sortorder | query | sort order | asc | "ASC" or "DESC" or "NONE" or "asc" or "desc" or "none" |
media type | data type | description |
---|---|---|
application/json | ConstructListResponse (JSON) | list of constructs |
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,
"parts" : [ {
"name" : "...",
"keyword" : "...",
"hidden" : true,
"editable" : true,
"liveEditable" : true,
"type" : "IMAGE",
"id" : 12345,
"globalId" : "...",
"defaultProperty" : { }
}, {
"name" : "...",
"keyword" : "...",
"hidden" : true,
"editable" : true,
"liveEditable" : true,
"type" : "PAGE",
"id" : 12345,
"globalId" : "...",
"defaultProperty" : { }
} ],
"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,
"parts" : [ {
"name" : "...",
"keyword" : "...",
"hidden" : true,
"editable" : true,
"liveEditable" : true,
"type" : "BOOLEAN",
"id" : 12345,
"globalId" : "...",
"defaultProperty" : { }
}, {
"name" : "...",
"keyword" : "...",
"hidden" : true,
"editable" : true,
"liveEditable" : true,
"type" : "LOCALFILE",
"id" : 12345,
"globalId" : "...",
"defaultProperty" : { }
} ],
"visibleInMenu" : true
} ],
"hasMoreItems" : true,
"numItems" : 12345,
"messages" : [ {
"fieldName" : "...",
"message" : "...",
"type" : "INFO",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
}, {
"fieldName" : "...",
"message" : "...",
"type" : "INFO",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
} ],
"responseInfo" : {
"responseCode" : "INVALIDDATA",
"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. |
media type | data type | description |
---|---|---|
application/json | GenericResponse (JSON) | Response object |
POST /construct/delete/{constructId}/{idOrKeyname} Accept: application/json
HTTP/1.1 201 Created
Content-Type: application/json
{
"messages" : [ {
"fieldName" : "...",
"message" : "...",
"type" : "INFO",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
}, {
"fieldName" : "...",
"message" : "...",
"type" : "WARNING",
"timestamp" : 12345,
"image" : "...",
"sender" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
},
"id" : 12345
} ],
"responseInfo" : {
"responseCode" : "INVALIDDATA",
"responseMessage" : "...",
"property" : "..."
}
}