Rest Model for parts
name | data type | constraints | description |
---|---|---|---|
name | string | Part name | |
keyword | string | Part keyword | |
boolean | required boolean | True if the part is hidden | |
editable | boolean | required boolean | True if the part is editable |
liveEditable | boolean | required boolean | True if the part is live (inline) editable |
mandatory | boolean | required boolean | True if the part is mandatory |
type | Type | Part type | |
typeId | number | required int | Part type ID |
id | number | Local ID of the part | |
globalId | string | Global ID of the part | |
defaultProperty | Property | Default property | |
regex | RegexModel | Regular expression definition for validation of text parttypes | |
hideInEditor | boolean | required boolean | Flag for hiding the part in the Tag Editor |
externalEditorUrl | string | External editor URL | |
options | array of SelectOption | Possible options | |
overviewSettings | OverviewSetting | Overview settings (if type is OVERVIEW) | |
selectSettings | SelectSetting | Selection settings (if type is SELECT or MULTISELECT) | |
markupLanguageId | number | Optional markup language ID for restricting the part to a specific template markup | |
htmlClass | string | HTML Class, if the part is of type Type#LIST, Type#ORDEREDLIST or Type#UNORDEREDLIST | |
partOrder | number | Part order | |
policy | string | Validation policy | |
nameI18n | map of string | Map of translated names (keys are the language codes) |
Example
{ "name" : "...", "keyword" : "...", "hidden" : true, "editable" : true, "liveEditable" : true, "mandatory" : true, "type" : "TEMPLATETAG", "typeId" : 12345, "id" : 12345, "globalId" : "...", "defaultProperty" : { "type" : "FORM", "stringValue" : "...", "booleanValue" : true, "fileId" : 12345, "imageId" : 12345, "folderId" : 12345, "pageId" : 12345, "formId" : 12345, "stringValues" : [ "...", "..." ], "options" : [ { "id" : 12345, "key" : "...", "value" : "..." }, { "id" : 12345, "key" : "...", "value" : "..." } ], "selectedOptions" : [ { "id" : 12345, "key" : "...", "value" : "..." }, { "id" : 12345, "key" : "...", "value" : "..." } ], "datasourceId" : 12345, "overview" : { "listType" : "FILE", "selectType" : "MANUAL", "orderDirection" : "ASC", "orderBy" : "PDATE", "selectedItemIds" : [ 12345, 12345 ], "selectedNodeItemIds" : [ { }, { } ], "source" : "...", "maxItems" : 12345, "recursive" : true, "id" : 12345, "globalId" : "..." }, "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" : [ "FILE", "FILE" ], "selectTypes" : [ "FOLDER", "MANUAL" ], "hideSortOptions" : true, "stickyChannel" : true }, "selectSettings" : { "datasourceId" : 12345, "template" : "...", "options" : [ { "id" : 12345, "key" : "...", "value" : "..." }, { "id" : 12345, "key" : "...", "value" : "..." } ] }, "markupLanguageId" : 12345, "htmlClass" : "...", "partOrder" : 12345, "policy" : "...", "nameI18n" : { "property1" : "...", "property2" : "..." } }