REST Model of an object property definition
name | data type | description |
---|---|---|
id | number | Internal ID of the object property definition |
globalId | string | Global ID |
name | string | Name in the current language |
description | string | Description in the current language |
keyword | string | Keyword |
type | number | Type of objects, this object property definition is for |
constructId | number | Internal construct ID |
construct | Construct | Construct used by the object property (may be null, if not embedded in the response) |
required | boolean | True if the object property is required, false if not |
inheritable | boolean | True if the object property is inheritable, false if not |
syncContentset | boolean | True if the object property is synchronized for all languages (only for pages) |
syncChannelset | boolean | True if the object property is synchronized for all channel variants |
syncVariants | boolean | True if the object property is synchronized for all page variants |
restricted | boolean | True if the object property is restricted |
categoryId | number | Get the category ID (may be null) |
category | ObjectPropertyCategory | Category used by the object property (may be null, if not embedded in the response) |
nameI18n | map of string | |
descriptionI18n | map of string |
Example
{ "id" : 12345, "globalId" : "...", "name" : "...", "description" : "...", "keyword" : "...", "type" : 12345, "constructId" : 12345, "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" : "LOCALFILE", "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" : "SELECT", "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 }, "required" : true, "inheritable" : true, "syncContentset" : true, "syncChannelset" : true, "syncVariants" : true, "restricted" : true, "categoryId" : 12345, "category" : { "id" : 12345, "globalId" : "...", "name" : "...", "nameI18n" : { "property1" : "...", "property2" : "..." }, "sortOrder" : 12345 }, "nameI18n" : { "property1" : "...", "property2" : "..." }, "descriptionI18n" : { "property1" : "...", "property2" : "..." } }