ConstructListResponse Data Type

Response containing a list of constructs

Properties
name data type description
constructs array of Construct Get the constructs
hasMoreItems boolean True if more items are available (paging)
numItems number Get total number of items present
Properties inherited from GenericResponse
messages array of Message Messages contained in the response (which should be shown to the user)
responseInfo ResponseInfo

Example

{
  "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" : "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" : "OVERVIEW",
      "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" : "PAGE",
      "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" : "VELOCITY",
      "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" : "..."
  }
}