ConstructLoadResponse Data Type

Class representing the construct load response.

Properties
name data type constraints description
construct Construct   Returns the loaded construct
messages array of Message   Messages contained in the response (which should be shown to the user)
responseInfo ResponseInfo  
inBackground boolean required boolean Whether the job was pushed into the background.

Example

{
  "construct" : {
    "keyword" : "...",
    "mayBeSubtag" : true,
    "mayContainSubtags" : true,
    "id" : 12345,
    "globalId" : "...",
    "name" : "...",
    "description" : "...",
    "creator" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "cdate" : 12345,
    "editor" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "edate" : 12345,
    "category" : {
      "name" : "...",
      "constructs" : {
        "property1" : { },
        "property2" : { }
      },
      "id" : 12345,
      "globalId" : "...",
      "nameI18n" : {
        "property1" : "...",
        "property2" : "..."
      },
      "sortOrder" : 12345
    },
    "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" : "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" : "...",
    "openEditorOnInsert" : true,
    "editorControlStyle" : "ASIDE",
    "editorControlsInside" : true,
    "categoryId" : 12345
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  },
  "inBackground" : true
}