ConstructResource Resource

Resource for handling constructs

GET /construct

Get the list of constructs.
The result can be filtered by

  • keyword
  • name
  • description
and sorted by
  • id
  • globalId
  • keyword
  • name
  • description

Request Parameters
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
perms query Flag to add permission information for the returned items. false boolean no
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
Response Codes
code condition
200 The list of constructs is returned.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json PagedConstructListResponse (JSON) response containing a list of constructs
application/xml object

Example

Request
GET /construct
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "items" : [ { }, { } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "perms" : {
    "property1" : [ "formreport", "readitems" ],
    "property2" : [ "updateitems", "setperm" ]
  },
  "stagingStatus" : {
    "property1" : {
      "packageName" : "...",
      "included" : true
    },
    "property2" : {
      "packageName" : "...",
      "included" : true
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

POST /construct

Create new construct

Request Parameters
name type description constraints multivalued
nodeId query IDs of node assignments, mandatory int yes
Request Body
media type data type description
application/json Construct (JSON) construct
application/xml object
Response Codes
code condition
200 Construct {id} was created.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json ConstructLoadResponse (JSON) response containing created construct
application/xml object

Example

Request
POST /construct
Content-Type: application/json
Accept: application/json

                
{
  "keyword" : "...",
  "mayBeSubtag" : true,
  "mayContainSubtags" : true,
  "id" : 12345,
  "globalId" : "...",
  "name" : "...",
  "description" : "...",
  "icon" : "...",
  "creator" : {
    "id" : 12345,
    "firstName" : "...",
    "lastName" : "...",
    "description" : "...",
    "email" : "...",
    "groups" : [ {
      "id" : 12345,
      "name" : "...",
      "description" : "...",
      "children" : [ { }, { } ]
    }, {
      "id" : 12345,
      "name" : "...",
      "description" : "...",
      "children" : [ { }, { } ]
    } ],
    "login" : "...",
    "password" : "..."
  },
  "cdate" : 12345,
  "editor" : {
    "id" : 12345,
    "firstName" : "...",
    "lastName" : "...",
    "description" : "...",
    "email" : "...",
    "groups" : [ {
      "id" : 12345,
      "name" : "...",
      "description" : "...",
      "children" : [ { }, { } ]
    }, {
      "id" : 12345,
      "name" : "...",
      "description" : "...",
      "children" : [ { }, { } ]
    } ],
    "login" : "...",
    "password" : "..."
  },
  "edate" : 12345,
  "editdo" : 12345,
  "category" : "...",
  "categorySortorder" : 12345,
  "newEditor" : true,
  "externalEditorUrl" : "...",
  "parts" : [ {
    "name" : "...",
    "keyword" : "...",
    "hidden" : true,
    "editable" : true,
    "liveEditable" : true,
    "mandatory" : true,
    "type" : "FORM",
    "typeId" : 12345,
    "id" : 12345,
    "globalId" : "...",
    "defaultProperty" : {
      "type" : "TABLE",
      "stringValue" : "...",
      "booleanValue" : true,
      "fileId" : 12345,
      "imageId" : 12345,
      "folderId" : 12345,
      "pageId" : 12345,
      "formId" : 12345,
      "stringValues" : [ "...", "..." ],
      "options" : [ { }, { } ],
      "selectedOptions" : [ { }, { } ],
      "datasourceId" : 12345,
      "overview" : { },
      "templateId" : 12345,
      "contentTagId" : 12345,
      "templateTagId" : 12345,
      "nodeId" : 12345,
      "partId" : 12345,
      "id" : 12345,
      "globalId" : "..."
    },
    "regex" : {
      "id" : 12345,
      "name" : "...",
      "description" : "...",
      "expression" : "..."
    },
    "hideInEditor" : true,
    "externalEditorUrl" : "...",
    "options" : [ {
      "id" : 12345,
      "key" : "...",
      "value" : "..."
    }, {
      "id" : 12345,
      "key" : "...",
      "value" : "..."
    } ],
    "overviewSettings" : {
      "listTypes" : [ "FOLDER", "PAGE" ],
      "selectTypes" : [ "AUTO", "MANUAL" ],
      "hideSortOptions" : true,
      "stickyChannel" : true
    },
    "selectSettings" : {
      "datasourceId" : 12345,
      "template" : "...",
      "options" : [ { }, { } ]
    },
    "markupLanguageId" : 12345,
    "htmlClass" : "...",
    "partOrder" : 12345,
    "policy" : "...",
    "nameI18n" : {
      "property1" : "...",
      "property2" : "..."
    }
  }, {
    "name" : "...",
    "keyword" : "...",
    "hidden" : true,
    "editable" : true,
    "liveEditable" : true,
    "mandatory" : true,
    "type" : "LIST",
    "typeId" : 12345,
    "id" : 12345,
    "globalId" : "...",
    "defaultProperty" : {
      "type" : "TEMPLATETAG",
      "stringValue" : "...",
      "booleanValue" : true,
      "fileId" : 12345,
      "imageId" : 12345,
      "folderId" : 12345,
      "pageId" : 12345,
      "formId" : 12345,
      "stringValues" : [ "...", "..." ],
      "options" : [ { }, { } ],
      "selectedOptions" : [ { }, { } ],
      "datasourceId" : 12345,
      "overview" : { },
      "templateId" : 12345,
      "contentTagId" : 12345,
      "templateTagId" : 12345,
      "nodeId" : 12345,
      "partId" : 12345,
      "id" : 12345,
      "globalId" : "..."
    },
    "regex" : {
      "id" : 12345,
      "name" : "...",
      "description" : "...",
      "expression" : "..."
    },
    "hideInEditor" : true,
    "externalEditorUrl" : "...",
    "options" : [ {
      "id" : 12345,
      "key" : "...",
      "value" : "..."
    }, {
      "id" : 12345,
      "key" : "...",
      "value" : "..."
    } ],
    "overviewSettings" : {
      "listTypes" : [ "UNDEFINED", "FILE" ],
      "selectTypes" : [ "AUTO", "AUTO" ],
      "hideSortOptions" : true,
      "stickyChannel" : true
    },
    "selectSettings" : {
      "datasourceId" : 12345,
      "template" : "...",
      "options" : [ { }, { } ]
    },
    "markupLanguageId" : 12345,
    "htmlClass" : "...",
    "partOrder" : 12345,
    "policy" : "...",
    "nameI18n" : {
      "property1" : "...",
      "property2" : "..."
    }
  } ],
  "visibleInMenu" : true,
  "nameI18n" : {
    "property1" : "...",
    "property2" : "..."
  },
  "descriptionI18n" : {
    "property1" : "...",
    "property2" : "..."
  },
  "autoEnable" : true,
  "liveEditorTagName" : "...",
  "hopeditHook" : "...",
  "categoryId" : 12345
}
Response
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" : "DATASOURCE",
      "typeId" : 12345,
      "id" : 12345,
      "globalId" : "...",
      "defaultProperty" : { },
      "regex" : { },
      "hideInEditor" : true,
      "externalEditorUrl" : "...",
      "options" : [ { }, { } ],
      "overviewSettings" : { },
      "selectSettings" : { },
      "markupLanguageId" : 12345,
      "htmlClass" : "...",
      "partOrder" : 12345,
      "policy" : "...",
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      }
    }, {
      "name" : "...",
      "keyword" : "...",
      "hidden" : true,
      "editable" : true,
      "liveEditable" : true,
      "mandatory" : true,
      "type" : "LOCALFILE",
      "typeId" : 12345,
      "id" : 12345,
      "globalId" : "...",
      "defaultProperty" : { },
      "regex" : { },
      "hideInEditor" : true,
      "externalEditorUrl" : "...",
      "options" : [ { }, { } ],
      "overviewSettings" : { },
      "selectSettings" : { },
      "markupLanguageId" : 12345,
      "htmlClass" : "...",
      "partOrder" : 12345,
      "policy" : "...",
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      }
    } ],
    "visibleInMenu" : true,
    "nameI18n" : {
      "property1" : "...",
      "property2" : "..."
    },
    "descriptionI18n" : {
      "property1" : "...",
      "property2" : "..."
    },
    "autoEnable" : true,
    "liveEditorTagName" : "...",
    "hopeditHook" : "...",
    "categoryId" : 12345
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /construct/category

List all construct categories.
The result can be filtered by

  • id
  • globalId
  • name
and sorted by
  • id
  • globalId
  • name

Request Parameters
name type description default constraints
embed query Comma separated list of attributes that contain references to other objects, which shall be embedded into the returned objects.    
page query Returned page, if paging is used. Paging starts with 1 1 int
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
q query Query string for filtering    
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  
Response Codes
code condition
200 List of construct categories is returned.
200 The list is returned
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json ConstructCategoryListResponse (JSON) response with categories list
application/xml object

Example

Request
GET /construct/category
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "items" : [ { }, { } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "perms" : {
    "property1" : [ "delete", "update" ],
    "property2" : [ "create", "userassignment" ]
  },
  "stagingStatus" : {
    "property1" : {
      "packageName" : "...",
      "included" : true
    },
    "property2" : {
      "packageName" : "...",
      "included" : true
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

POST /construct/category

Create a new construct category

Request Body
media type data type description
application/json ConstructCategory (JSON) new category REST model
application/xml object
Response Codes
code condition
200 The construct category has been created.
200 The category
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json ConstructCategoryLoadResponse (JSON) response containing the construct category
application/xml object

Example

Request
POST /construct/category
Content-Type: application/json
Accept: application/json

                
{
  "name" : "...",
  "constructs" : {
    "property1" : {
      "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" : { },
        "markupLanguageId" : 12345,
        "htmlClass" : "...",
        "partOrder" : 12345,
        "policy" : "...",
        "nameI18n" : {
          "property1" : "...",
          "property2" : "..."
        }
      }, {
        "name" : "...",
        "keyword" : "...",
        "hidden" : true,
        "editable" : true,
        "liveEditable" : true,
        "mandatory" : true,
        "type" : "FILE",
        "typeId" : 12345,
        "id" : 12345,
        "globalId" : "...",
        "defaultProperty" : { },
        "regex" : { },
        "hideInEditor" : true,
        "externalEditorUrl" : "...",
        "options" : [ { }, { } ],
        "overviewSettings" : { },
        "selectSettings" : { },
        "markupLanguageId" : 12345,
        "htmlClass" : "...",
        "partOrder" : 12345,
        "policy" : "...",
        "nameI18n" : {
          "property1" : "...",
          "property2" : "..."
        }
      } ],
      "visibleInMenu" : true,
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "descriptionI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "autoEnable" : true,
      "liveEditorTagName" : "...",
      "hopeditHook" : "...",
      "categoryId" : 12345
    },
    "property2" : {
      "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" : { },
        "markupLanguageId" : 12345,
        "htmlClass" : "...",
        "partOrder" : 12345,
        "policy" : "...",
        "nameI18n" : {
          "property1" : "...",
          "property2" : "..."
        }
      }, {
        "name" : "...",
        "keyword" : "...",
        "hidden" : true,
        "editable" : true,
        "liveEditable" : true,
        "mandatory" : true,
        "type" : "LIST",
        "typeId" : 12345,
        "id" : 12345,
        "globalId" : "...",
        "defaultProperty" : { },
        "regex" : { },
        "hideInEditor" : true,
        "externalEditorUrl" : "...",
        "options" : [ { }, { } ],
        "overviewSettings" : { },
        "selectSettings" : { },
        "markupLanguageId" : 12345,
        "htmlClass" : "...",
        "partOrder" : 12345,
        "policy" : "...",
        "nameI18n" : {
          "property1" : "...",
          "property2" : "..."
        }
      } ],
      "visibleInMenu" : true,
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "descriptionI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "autoEnable" : true,
      "liveEditorTagName" : "...",
      "hopeditHook" : "...",
      "categoryId" : 12345
    }
  },
  "id" : 12345,
  "globalId" : "...",
  "nameI18n" : {
    "property1" : "...",
    "property2" : "..."
  }
}
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "constructCategory" : {
    "name" : "...",
    "constructs" : {
      "property1" : {
        "keyword" : "...",
        "mayBeSubtag" : true,
        "mayContainSubtags" : true,
        "id" : 12345,
        "globalId" : "...",
        "name" : "...",
        "description" : "...",
        "icon" : "...",
        "creator" : { },
        "cdate" : 12345,
        "editor" : { },
        "edate" : 12345,
        "editdo" : 12345,
        "category" : "...",
        "categorySortorder" : 12345,
        "newEditor" : true,
        "externalEditorUrl" : "...",
        "parts" : [ { }, { } ],
        "visibleInMenu" : true,
        "nameI18n" : {
          "property1" : "...",
          "property2" : "..."
        },
        "descriptionI18n" : {
          "property1" : "...",
          "property2" : "..."
        },
        "autoEnable" : true,
        "liveEditorTagName" : "...",
        "hopeditHook" : "...",
        "categoryId" : 12345
      },
      "property2" : {
        "keyword" : "...",
        "mayBeSubtag" : true,
        "mayContainSubtags" : true,
        "id" : 12345,
        "globalId" : "...",
        "name" : "...",
        "description" : "...",
        "icon" : "...",
        "creator" : { },
        "cdate" : 12345,
        "editor" : { },
        "edate" : 12345,
        "editdo" : 12345,
        "category" : "...",
        "categorySortorder" : 12345,
        "newEditor" : true,
        "externalEditorUrl" : "...",
        "parts" : [ { }, { } ],
        "visibleInMenu" : true,
        "nameI18n" : {
          "property1" : "...",
          "property2" : "..."
        },
        "descriptionI18n" : {
          "property1" : "...",
          "property2" : "..."
        },
        "autoEnable" : true,
        "liveEditorTagName" : "...",
        "hopeditHook" : "...",
        "categoryId" : 12345
      }
    },
    "id" : 12345,
    "globalId" : "...",
    "nameI18n" : {
      "property1" : "...",
      "property2" : "..."
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}
See Also
GET ConstructResource

GET /construct/list

This method has been deprecated.

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.

See Also
GET ConstructResource
Request Parameters
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
Response Codes
code condition
200 The list of constructs is returned.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json ConstructListResponse (JSON) list of constructs
application/xml object

Example

Request
GET /construct/list
Content-Type: application/json
Accept: application/json

                
...
Response
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" : "DATASOURCE",
      "typeId" : 12345,
      "id" : 12345,
      "globalId" : "...",
      "defaultProperty" : { },
      "regex" : { },
      "hideInEditor" : true,
      "externalEditorUrl" : "...",
      "options" : [ { }, { } ],
      "overviewSettings" : { },
      "selectSettings" : { },
      "markupLanguageId" : 12345,
      "htmlClass" : "...",
      "partOrder" : 12345,
      "policy" : "...",
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      }
    }, {
      "name" : "...",
      "keyword" : "...",
      "hidden" : true,
      "editable" : true,
      "liveEditable" : true,
      "mandatory" : true,
      "type" : "PAGETAG",
      "typeId" : 12345,
      "id" : 12345,
      "globalId" : "...",
      "defaultProperty" : { },
      "regex" : { },
      "hideInEditor" : true,
      "externalEditorUrl" : "...",
      "options" : [ { }, { } ],
      "overviewSettings" : { },
      "selectSettings" : { },
      "markupLanguageId" : 12345,
      "htmlClass" : "...",
      "partOrder" : 12345,
      "policy" : "...",
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      }
    } ],
    "visibleInMenu" : true,
    "nameI18n" : {
      "property1" : "...",
      "property2" : "..."
    },
    "descriptionI18n" : {
      "property1" : "...",
      "property2" : "..."
    },
    "autoEnable" : true,
    "liveEditorTagName" : "...",
    "hopeditHook" : "...",
    "categoryId" : 12345
  }, {
    "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" : "FOLDER",
      "typeId" : 12345,
      "id" : 12345,
      "globalId" : "...",
      "defaultProperty" : { },
      "regex" : { },
      "hideInEditor" : true,
      "externalEditorUrl" : "...",
      "options" : [ { }, { } ],
      "overviewSettings" : { },
      "selectSettings" : { },
      "markupLanguageId" : 12345,
      "htmlClass" : "...",
      "partOrder" : 12345,
      "policy" : "...",
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      }
    }, {
      "name" : "...",
      "keyword" : "...",
      "hidden" : true,
      "editable" : true,
      "liveEditable" : true,
      "mandatory" : true,
      "type" : "TABLE",
      "typeId" : 12345,
      "id" : 12345,
      "globalId" : "...",
      "defaultProperty" : { },
      "regex" : { },
      "hideInEditor" : true,
      "externalEditorUrl" : "...",
      "options" : [ { }, { } ],
      "overviewSettings" : { },
      "selectSettings" : { },
      "markupLanguageId" : 12345,
      "htmlClass" : "...",
      "partOrder" : 12345,
      "policy" : "...",
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      }
    } ],
    "visibleInMenu" : true,
    "nameI18n" : {
      "property1" : "...",
      "property2" : "..."
    },
    "descriptionI18n" : {
      "property1" : "...",
      "property2" : "..."
    },
    "autoEnable" : true,
    "liveEditorTagName" : "...",
    "hopeditHook" : "...",
    "categoryId" : 12345
  } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

DELETE /construct/{id}

Delete a construct

Request Parameters
name type description
id path construct ID
Response Codes
code condition
200 Construct {id} was deleted.
404 Construct {id} does not exist.
409 Construct {id} could not be deleted due to a conflict.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json GenericResponse (JSON) empty response
application/xml object

Example

Request
DELETE /construct/{id}
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /construct/{id}

Get existing construct

Request Parameters
name type description
id path construct ID
Response Codes
code condition
200 Construct {id} exists.
404 Construct {id} does not exist.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json ConstructLoadResponse (JSON) response containing the construct
application/xml object

Example

Request
GET /construct/{id}
Content-Type: application/json
Accept: application/json

                
...
Response
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" : { },
      "markupLanguageId" : 12345,
      "htmlClass" : "...",
      "partOrder" : 12345,
      "policy" : "...",
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      }
    }, {
      "name" : "...",
      "keyword" : "...",
      "hidden" : true,
      "editable" : true,
      "liveEditable" : true,
      "mandatory" : true,
      "type" : "FOLDER",
      "typeId" : 12345,
      "id" : 12345,
      "globalId" : "...",
      "defaultProperty" : { },
      "regex" : { },
      "hideInEditor" : true,
      "externalEditorUrl" : "...",
      "options" : [ { }, { } ],
      "overviewSettings" : { },
      "selectSettings" : { },
      "markupLanguageId" : 12345,
      "htmlClass" : "...",
      "partOrder" : 12345,
      "policy" : "...",
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      }
    } ],
    "visibleInMenu" : true,
    "nameI18n" : {
      "property1" : "...",
      "property2" : "..."
    },
    "descriptionI18n" : {
      "property1" : "...",
      "property2" : "..."
    },
    "autoEnable" : true,
    "liveEditorTagName" : "...",
    "hopeditHook" : "...",
    "categoryId" : 12345
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

PUT /construct/{id}

Update a construct

Request Parameters
name type description constraints multivalued
id path construct ID   no
nodeId query IDs of new node assignments int yes
Request Body
media type data type description
application/json Construct (JSON) updated construct data
application/xml object
Response Codes
code condition
200 Construct {id} was updated.
404 Construct {id} does not exist.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json ConstructLoadResponse (JSON) response containing the updated construct
application/xml object

Example

Request
PUT /construct/{id}
Content-Type: application/json
Accept: application/json

                
{
  "keyword" : "...",
  "mayBeSubtag" : true,
  "mayContainSubtags" : true,
  "id" : 12345,
  "globalId" : "...",
  "name" : "...",
  "description" : "...",
  "icon" : "...",
  "creator" : {
    "id" : 12345,
    "firstName" : "...",
    "lastName" : "...",
    "description" : "...",
    "email" : "...",
    "groups" : [ {
      "id" : 12345,
      "name" : "...",
      "description" : "...",
      "children" : [ { }, { } ]
    }, {
      "id" : 12345,
      "name" : "...",
      "description" : "...",
      "children" : [ { }, { } ]
    } ],
    "login" : "...",
    "password" : "..."
  },
  "cdate" : 12345,
  "editor" : {
    "id" : 12345,
    "firstName" : "...",
    "lastName" : "...",
    "description" : "...",
    "email" : "...",
    "groups" : [ {
      "id" : 12345,
      "name" : "...",
      "description" : "...",
      "children" : [ { }, { } ]
    }, {
      "id" : 12345,
      "name" : "...",
      "description" : "...",
      "children" : [ { }, { } ]
    } ],
    "login" : "...",
    "password" : "..."
  },
  "edate" : 12345,
  "editdo" : 12345,
  "category" : "...",
  "categorySortorder" : 12345,
  "newEditor" : true,
  "externalEditorUrl" : "...",
  "parts" : [ {
    "name" : "...",
    "keyword" : "...",
    "hidden" : true,
    "editable" : true,
    "liveEditable" : true,
    "mandatory" : true,
    "type" : "FILE",
    "typeId" : 12345,
    "id" : 12345,
    "globalId" : "...",
    "defaultProperty" : {
      "type" : "NODE",
      "stringValue" : "...",
      "booleanValue" : true,
      "fileId" : 12345,
      "imageId" : 12345,
      "folderId" : 12345,
      "pageId" : 12345,
      "formId" : 12345,
      "stringValues" : [ "...", "..." ],
      "options" : [ { }, { } ],
      "selectedOptions" : [ { }, { } ],
      "datasourceId" : 12345,
      "overview" : { },
      "templateId" : 12345,
      "contentTagId" : 12345,
      "templateTagId" : 12345,
      "nodeId" : 12345,
      "partId" : 12345,
      "id" : 12345,
      "globalId" : "..."
    },
    "regex" : {
      "id" : 12345,
      "name" : "...",
      "description" : "...",
      "expression" : "..."
    },
    "hideInEditor" : true,
    "externalEditorUrl" : "...",
    "options" : [ {
      "id" : 12345,
      "key" : "...",
      "value" : "..."
    }, {
      "id" : 12345,
      "key" : "...",
      "value" : "..."
    } ],
    "overviewSettings" : {
      "listTypes" : [ "IMAGE", "IMAGE" ],
      "selectTypes" : [ "UNDEFINED", "UNDEFINED" ],
      "hideSortOptions" : true,
      "stickyChannel" : true
    },
    "selectSettings" : {
      "datasourceId" : 12345,
      "template" : "...",
      "options" : [ { }, { } ]
    },
    "markupLanguageId" : 12345,
    "htmlClass" : "...",
    "partOrder" : 12345,
    "policy" : "...",
    "nameI18n" : {
      "property1" : "...",
      "property2" : "..."
    }
  }, {
    "name" : "...",
    "keyword" : "...",
    "hidden" : true,
    "editable" : true,
    "liveEditable" : true,
    "mandatory" : true,
    "type" : "FILE",
    "typeId" : 12345,
    "id" : 12345,
    "globalId" : "...",
    "defaultProperty" : {
      "type" : "NAVIGATION",
      "stringValue" : "...",
      "booleanValue" : true,
      "fileId" : 12345,
      "imageId" : 12345,
      "folderId" : 12345,
      "pageId" : 12345,
      "formId" : 12345,
      "stringValues" : [ "...", "..." ],
      "options" : [ { }, { } ],
      "selectedOptions" : [ { }, { } ],
      "datasourceId" : 12345,
      "overview" : { },
      "templateId" : 12345,
      "contentTagId" : 12345,
      "templateTagId" : 12345,
      "nodeId" : 12345,
      "partId" : 12345,
      "id" : 12345,
      "globalId" : "..."
    },
    "regex" : {
      "id" : 12345,
      "name" : "...",
      "description" : "...",
      "expression" : "..."
    },
    "hideInEditor" : true,
    "externalEditorUrl" : "...",
    "options" : [ {
      "id" : 12345,
      "key" : "...",
      "value" : "..."
    }, {
      "id" : 12345,
      "key" : "...",
      "value" : "..."
    } ],
    "overviewSettings" : {
      "listTypes" : [ "FOLDER", "IMAGE" ],
      "selectTypes" : [ "MANUAL", "UNDEFINED" ],
      "hideSortOptions" : true,
      "stickyChannel" : true
    },
    "selectSettings" : {
      "datasourceId" : 12345,
      "template" : "...",
      "options" : [ { }, { } ]
    },
    "markupLanguageId" : 12345,
    "htmlClass" : "...",
    "partOrder" : 12345,
    "policy" : "...",
    "nameI18n" : {
      "property1" : "...",
      "property2" : "..."
    }
  } ],
  "visibleInMenu" : true,
  "nameI18n" : {
    "property1" : "...",
    "property2" : "..."
  },
  "descriptionI18n" : {
    "property1" : "...",
    "property2" : "..."
  },
  "autoEnable" : true,
  "liveEditorTagName" : "...",
  "hopeditHook" : "...",
  "categoryId" : 12345
}
Response
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" : "FORM",
      "typeId" : 12345,
      "id" : 12345,
      "globalId" : "...",
      "defaultProperty" : { },
      "regex" : { },
      "hideInEditor" : true,
      "externalEditorUrl" : "...",
      "options" : [ { }, { } ],
      "overviewSettings" : { },
      "selectSettings" : { },
      "markupLanguageId" : 12345,
      "htmlClass" : "...",
      "partOrder" : 12345,
      "policy" : "...",
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      }
    }, {
      "name" : "...",
      "keyword" : "...",
      "hidden" : true,
      "editable" : true,
      "liveEditable" : true,
      "mandatory" : true,
      "type" : "DATASOURCE",
      "typeId" : 12345,
      "id" : 12345,
      "globalId" : "...",
      "defaultProperty" : { },
      "regex" : { },
      "hideInEditor" : true,
      "externalEditorUrl" : "...",
      "options" : [ { }, { } ],
      "overviewSettings" : { },
      "selectSettings" : { },
      "markupLanguageId" : 12345,
      "htmlClass" : "...",
      "partOrder" : 12345,
      "policy" : "...",
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      }
    } ],
    "visibleInMenu" : true,
    "nameI18n" : {
      "property1" : "...",
      "property2" : "..."
    },
    "descriptionI18n" : {
      "property1" : "...",
      "property2" : "..."
    },
    "autoEnable" : true,
    "liveEditorTagName" : "...",
    "hopeditHook" : "...",
    "categoryId" : 12345
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

DELETE /construct/category/{id}

Delete the construct category by its ID

Request Parameters
name type description
id path construct category ID
Response Codes
code condition
200 The construct category has been loaded.
404 The construct category {id} does not exist.
200 The category is deleted
404 The category with ID {id} does not exist
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json GenericResponse (JSON) general success response
application/xml object

Example

Request
DELETE /construct/category/{id}
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /construct/category/{id}

Load the construct category by its ID

Request Parameters
name type description
id path construct category ID
Response Codes
code condition
200 The construct category has been loaded.
404 The construct category {id} does not exist.
200 The category is returned.
404 The category with ID {id} does not exist
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json ConstructCategoryLoadResponse (JSON) response containing the construct category
application/xml object

Example

Request
GET /construct/category/{id}
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "constructCategory" : {
    "name" : "...",
    "constructs" : {
      "property1" : {
        "keyword" : "...",
        "mayBeSubtag" : true,
        "mayContainSubtags" : true,
        "id" : 12345,
        "globalId" : "...",
        "name" : "...",
        "description" : "...",
        "icon" : "...",
        "creator" : { },
        "cdate" : 12345,
        "editor" : { },
        "edate" : 12345,
        "editdo" : 12345,
        "category" : "...",
        "categorySortorder" : 12345,
        "newEditor" : true,
        "externalEditorUrl" : "...",
        "parts" : [ { }, { } ],
        "visibleInMenu" : true,
        "nameI18n" : {
          "property1" : "...",
          "property2" : "..."
        },
        "descriptionI18n" : {
          "property1" : "...",
          "property2" : "..."
        },
        "autoEnable" : true,
        "liveEditorTagName" : "...",
        "hopeditHook" : "...",
        "categoryId" : 12345
      },
      "property2" : {
        "keyword" : "...",
        "mayBeSubtag" : true,
        "mayContainSubtags" : true,
        "id" : 12345,
        "globalId" : "...",
        "name" : "...",
        "description" : "...",
        "icon" : "...",
        "creator" : { },
        "cdate" : 12345,
        "editor" : { },
        "edate" : 12345,
        "editdo" : 12345,
        "category" : "...",
        "categorySortorder" : 12345,
        "newEditor" : true,
        "externalEditorUrl" : "...",
        "parts" : [ { }, { } ],
        "visibleInMenu" : true,
        "nameI18n" : {
          "property1" : "...",
          "property2" : "..."
        },
        "descriptionI18n" : {
          "property1" : "...",
          "property2" : "..."
        },
        "autoEnable" : true,
        "liveEditorTagName" : "...",
        "hopeditHook" : "...",
        "categoryId" : 12345
      }
    },
    "id" : 12345,
    "globalId" : "...",
    "nameI18n" : {
      "property1" : "...",
      "property2" : "..."
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

PUT /construct/category/{id}

Edit the construct category by its ID

Request Parameters
name type description
id path construct category ID
Request Body
media type data type
application/json ConstructCategory (JSON)
application/xml object
Response Codes
code condition
200 The construct category has been loaded.
404 The construct category {id} does not exist.
200 The updated category is returned.
404 The category with ID {id} does not exist
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json ConstructCategoryLoadResponse (JSON) response containing the updated category
application/xml object

Example

Request
PUT /construct/category/{id}
Content-Type: application/json
Accept: application/json

                
{
  "name" : "...",
  "constructs" : {
    "property1" : {
      "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" : "NAVIGATION",
        "typeId" : 12345,
        "id" : 12345,
        "globalId" : "...",
        "defaultProperty" : { },
        "regex" : { },
        "hideInEditor" : true,
        "externalEditorUrl" : "...",
        "options" : [ { }, { } ],
        "overviewSettings" : { },
        "selectSettings" : { },
        "markupLanguageId" : 12345,
        "htmlClass" : "...",
        "partOrder" : 12345,
        "policy" : "...",
        "nameI18n" : {
          "property1" : "...",
          "property2" : "..."
        }
      }, {
        "name" : "...",
        "keyword" : "...",
        "hidden" : true,
        "editable" : true,
        "liveEditable" : true,
        "mandatory" : true,
        "type" : "MULTISELECT",
        "typeId" : 12345,
        "id" : 12345,
        "globalId" : "...",
        "defaultProperty" : { },
        "regex" : { },
        "hideInEditor" : true,
        "externalEditorUrl" : "...",
        "options" : [ { }, { } ],
        "overviewSettings" : { },
        "selectSettings" : { },
        "markupLanguageId" : 12345,
        "htmlClass" : "...",
        "partOrder" : 12345,
        "policy" : "...",
        "nameI18n" : {
          "property1" : "...",
          "property2" : "..."
        }
      } ],
      "visibleInMenu" : true,
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "descriptionI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "autoEnable" : true,
      "liveEditorTagName" : "...",
      "hopeditHook" : "...",
      "categoryId" : 12345
    },
    "property2" : {
      "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" : { },
        "markupLanguageId" : 12345,
        "htmlClass" : "...",
        "partOrder" : 12345,
        "policy" : "...",
        "nameI18n" : {
          "property1" : "...",
          "property2" : "..."
        }
      }, {
        "name" : "...",
        "keyword" : "...",
        "hidden" : true,
        "editable" : true,
        "liveEditable" : true,
        "mandatory" : true,
        "type" : "UNKNOWN",
        "typeId" : 12345,
        "id" : 12345,
        "globalId" : "...",
        "defaultProperty" : { },
        "regex" : { },
        "hideInEditor" : true,
        "externalEditorUrl" : "...",
        "options" : [ { }, { } ],
        "overviewSettings" : { },
        "selectSettings" : { },
        "markupLanguageId" : 12345,
        "htmlClass" : "...",
        "partOrder" : 12345,
        "policy" : "...",
        "nameI18n" : {
          "property1" : "...",
          "property2" : "..."
        }
      } ],
      "visibleInMenu" : true,
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "descriptionI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "autoEnable" : true,
      "liveEditorTagName" : "...",
      "hopeditHook" : "...",
      "categoryId" : 12345
    }
  },
  "id" : 12345,
  "globalId" : "...",
  "nameI18n" : {
    "property1" : "...",
    "property2" : "..."
  }
}
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "constructCategory" : {
    "name" : "...",
    "constructs" : {
      "property1" : {
        "keyword" : "...",
        "mayBeSubtag" : true,
        "mayContainSubtags" : true,
        "id" : 12345,
        "globalId" : "...",
        "name" : "...",
        "description" : "...",
        "icon" : "...",
        "creator" : { },
        "cdate" : 12345,
        "editor" : { },
        "edate" : 12345,
        "editdo" : 12345,
        "category" : "...",
        "categorySortorder" : 12345,
        "newEditor" : true,
        "externalEditorUrl" : "...",
        "parts" : [ { }, { } ],
        "visibleInMenu" : true,
        "nameI18n" : {
          "property1" : "...",
          "property2" : "..."
        },
        "descriptionI18n" : {
          "property1" : "...",
          "property2" : "..."
        },
        "autoEnable" : true,
        "liveEditorTagName" : "...",
        "hopeditHook" : "...",
        "categoryId" : 12345
      },
      "property2" : {
        "keyword" : "...",
        "mayBeSubtag" : true,
        "mayContainSubtags" : true,
        "id" : 12345,
        "globalId" : "...",
        "name" : "...",
        "description" : "...",
        "icon" : "...",
        "creator" : { },
        "cdate" : 12345,
        "editor" : { },
        "edate" : 12345,
        "editdo" : 12345,
        "category" : "...",
        "categorySortorder" : 12345,
        "newEditor" : true,
        "externalEditorUrl" : "...",
        "parts" : [ { }, { } ],
        "visibleInMenu" : true,
        "nameI18n" : {
          "property1" : "...",
          "property2" : "..."
        },
        "descriptionI18n" : {
          "property1" : "...",
          "property2" : "..."
        },
        "autoEnable" : true,
        "liveEditorTagName" : "...",
        "hopeditHook" : "...",
        "categoryId" : 12345
      }
    },
    "id" : 12345,
    "globalId" : "...",
    "nameI18n" : {
      "property1" : "...",
      "property2" : "..."
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

POST /construct/link/nodes

Link a set of constructs to the selected nodes

Request Body
media type data type description
application/json BulkLinkUpdateRequest (JSON) POST body with source + target IDs
application/xml object
Response Codes
code condition
200 The link succeeded for all the requested entities.
404 The distinct node or construct does not exist.
200 The link succeeded for all the requested entities
404 The distinct node or construct does not exist
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json GenericResponse (JSON) general success response
application/xml object

Example

Request
POST /construct/link/nodes
Content-Type: application/json
Accept: application/json

                
{
  "ids" : [ 12345, 12345 ],
  "targetIds" : [ "...", "..." ]
}
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /construct/load/{constructId}

Load the insertable construct and it's categories for a given constructId

Request Parameters
name type description constraints
constructId path construct ID int
Response Codes
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.
Response Body
media type data type description
application/json ConstructLoadResponse (JSON) response containing the construct
application/xml object

Example

Request
GET /construct/load/{constructId}
Content-Type: application/json
Accept: application/json

                
...
Response
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" : "ORDEREDLIST",
      "typeId" : 12345,
      "id" : 12345,
      "globalId" : "...",
      "defaultProperty" : { },
      "regex" : { },
      "hideInEditor" : true,
      "externalEditorUrl" : "...",
      "options" : [ { }, { } ],
      "overviewSettings" : { },
      "selectSettings" : { },
      "markupLanguageId" : 12345,
      "htmlClass" : "...",
      "partOrder" : 12345,
      "policy" : "...",
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      }
    }, {
      "name" : "...",
      "keyword" : "...",
      "hidden" : true,
      "editable" : true,
      "liveEditable" : true,
      "mandatory" : true,
      "type" : "ORDEREDLIST",
      "typeId" : 12345,
      "id" : 12345,
      "globalId" : "...",
      "defaultProperty" : { },
      "regex" : { },
      "hideInEditor" : true,
      "externalEditorUrl" : "...",
      "options" : [ { }, { } ],
      "overviewSettings" : { },
      "selectSettings" : { },
      "markupLanguageId" : 12345,
      "htmlClass" : "...",
      "partOrder" : 12345,
      "policy" : "...",
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      }
    } ],
    "visibleInMenu" : true,
    "nameI18n" : {
      "property1" : "...",
      "property2" : "..."
    },
    "descriptionI18n" : {
      "property1" : "...",
      "property2" : "..."
    },
    "autoEnable" : true,
    "liveEditorTagName" : "...",
    "hopeditHook" : "...",
    "categoryId" : 12345
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

POST /construct/unlink/nodes

Unlink a set of constructs from the selected nodes

Request Body
media type data type description
application/json BulkLinkUpdateRequest (JSON) POST body with source + target IDs
application/xml object
Response Codes
code condition
200 The unlink succeeded for all the requested entities.
404 The distinct node or construct does not exist.
200 The unlink succeeded for all the requested entities.
404 The distinct node or construct does not exist
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json GenericResponse (JSON) general success response
application/xml object

Example

Request
POST /construct/unlink/nodes
Content-Type: application/json
Accept: application/json

                
{
  "ids" : [ 12345, 12345 ],
  "targetIds" : [ "...", "..." ]
}
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /construct/{id}/hash

Get the implementation hash for a construct

Request Parameters
name type description
id path construct ID
Response Codes
code condition
200 Construct {id} exists.
404 Construct {id} does not exist.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json ImplementationHashResponse (JSON) response with implementation hash
application/xml object

Example

Request
GET /construct/{id}/hash
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "hash" : "...",
  "base" : "...",
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

GET /construct/{id}/nodes

Return a list of nodes, linked to the the given Construct

Request Parameters
name type description
id path
Response Codes
code condition
200 The list of nodes for construct {id}, permitted for the reading for the current user, is returned.
404 The construct {id} does not exist.
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json NodeList (JSON)
application/xml object

Example

Request
GET /construct/{id}/nodes
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "items" : [ { }, { } ],
  "hasMoreItems" : true,
  "numItems" : 12345,
  "perms" : {
    "property1" : [ "linktemplates", "createtemplates" ],
    "property2" : [ "read", "createitems" ]
  },
  "stagingStatus" : {
    "property1" : {
      "packageName" : "...",
      "included" : true
    },
    "property2" : {
      "packageName" : "...",
      "included" : true
    }
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}

POST /construct/delete/{constructId}/{idOrKeyname}

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.

Request Parameters
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.
Response Codes
code condition
200 The part has been deleted
401 No valid sid and session secret cookie were provided.
403 User has insufficient permissions.
Response Body
media type data type description
application/json GenericResponse (JSON) Response object
application/xml object

Example

Request
POST /construct/delete/{constructId}/{idOrKeyname}
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  }
}