Construct
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 | |
boolean | Whether this construct may contain other tags. | ||
|
|
|
|
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 | |
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 |
category | ConstructCategory | Category of the construct | |
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 | |
openEditorOnInsert | boolean | required boolean | Whether the tag editor should be opened immediately when the construct is inserted. |
editorControlStyle | EditorControlStyle | Get the placement mode for edit icons. | |
editorControlsInside | boolean | required boolean | Whether the edit icons should be displayed inside the rendered construct. |
categoryId | number | ID of the category of this construct |
Example
{ "keyword" : "...", "mayBeSubtag" : true, "mayContainSubtags" : true, "id" : 12345, "globalId" : "...", "name" : "...", "description" : "...", "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, "category" : { "name" : "...", "constructs" : { "property1" : { "keyword" : "...", "mayBeSubtag" : true, "mayContainSubtags" : true, "id" : 12345, "globalId" : "...", "name" : "...", "description" : "...", "creator" : { }, "cdate" : 12345, "editor" : { }, "edate" : 12345, "category" : { }, "externalEditorUrl" : "...", "parts" : [ { }, { } ], "visibleInMenu" : true, "nameI18n" : { "property1" : "...", "property2" : "..." }, "descriptionI18n" : { "property1" : "...", "property2" : "..." }, "autoEnable" : true, "liveEditorTagName" : "...", "openEditorOnInsert" : true, "editorControlStyle" : "ABOVE", "editorControlsInside" : true, "categoryId" : 12345 }, "property2" : { "keyword" : "...", "mayBeSubtag" : true, "mayContainSubtags" : true, "id" : 12345, "globalId" : "...", "name" : "...", "description" : "...", "creator" : { }, "cdate" : 12345, "editor" : { }, "edate" : 12345, "category" : { }, "externalEditorUrl" : "...", "parts" : [ { }, { } ], "visibleInMenu" : true, "nameI18n" : { "property1" : "...", "property2" : "..." }, "descriptionI18n" : { "property1" : "...", "property2" : "..." }, "autoEnable" : true, "liveEditorTagName" : "...", "openEditorOnInsert" : true, "editorControlStyle" : "CLICK", "editorControlsInside" : true, "categoryId" : 12345 } }, "id" : 12345, "globalId" : "...", "nameI18n" : { "property1" : "...", "property2" : "..." }, "sortOrder" : 12345 }, "externalEditorUrl" : "...", "parts" : [ { "name" : "...", "keyword" : "...", "hidden" : true, "editable" : true, "liveEditable" : true, "mandatory" : true, "type" : "NODE", "typeId" : 12345, "id" : 12345, "globalId" : "...", "defaultProperty" : { "type" : "IMAGE", "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", "IMAGE" ], "selectTypes" : [ "UNDEFINED", "FOLDER" ], "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" : "TEMPLATETAG", "typeId" : 12345, "id" : 12345, "globalId" : "...", "defaultProperty" : { "type" : "DATASOURCE", "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" : [ "PAGE", "IMAGE" ], "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" : "...", "openEditorOnInsert" : true, "editorControlStyle" : "CLICK", "editorControlsInside" : true, "categoryId" : 12345 }