Construct Data Type

Construct

Subtypes
ConstructInPackage
Properties
name data type constraints description
keyword string   Keyword for this construct
mayBeSubtag boolean   Whether a tag of this construct may be inserted/nested in other tags
mayContainSubtags boolean   Whether this construct may contain other tags.
constructId number   Construct id of this construct
id number   ID of this construct
globalId string   Global ID of the construct
name string   Name of this construct
description string   Description of this construct
icon string   Icon of this construct
creator User   Creator of the construct
cdate number required int Creation Date of the construct
editor User   Last Editor of the construct
edate number required int Last Edit Date of the construct
editdo number   Edit do
category string   Category name of the construct
categorySortorder number required int Order for the category that was set
newEditor boolean   Flag for using the new Tag Editor
externalEditorUrl string   External editor URL
parts array of Part   Parts of the construct
visibleInMenu boolean   True if the construct shall be visible in the menu, false if not
nameI18n map of string   Map of translated names (keys are the language codes)
descriptionI18n map of string   Map of translated descriptions (keys are the language codes)
autoEnable boolean   Flag for automatically enabling new tags, which are created based on this construct
liveEditorTagName string   HTML tag name, which is used when tags based on this construct are edited with the live editor
hopeditHook string   Javascript "hopedit" hook which, if available should replace the "hopedit" call.
categoryId number   ID of the category of this construct

Example

{
  "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" : "SELECT",
    "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", "IMAGE" ],
      "selectTypes" : [ "UNDEFINED", "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" : "VELOCITY",
    "typeId" : 12345,
    "id" : 12345,
    "globalId" : "...",
    "defaultProperty" : {
      "type" : "RICHTEXT",
      "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", "FOLDER" ],
      "selectTypes" : [ "MANUAL", "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
}