ObjectTag Data Type

Tag object representing a contenttag in the GCN

Properties
name data type description
displayName string Display name
description string Description
required boolean True when the objectag is required
inheritable boolean True when the object tag can be inherited onto other objects (e.g. from a folder to objects contained in the folder, or from a template to pages)
id number ID
name string Name
constructId number Construct ID
categoryId number Category ID
construct Construct Embedded construct
active boolean True when the tag is active
categoryName string Category name
properties map of Property Tag properties
type Type Tag type
sortOrder number Sort order of the object tag (for display in the object tag list while editing)
readOnly boolean True when the objecttag cannot be modified
rootTag boolean Whether this tag is a root tag (i.e., it comes from the template).
inherited boolean Whether this tag is inherited in a partially localized page.

Example

{
  "displayName" : "...",
  "description" : "...",
  "required" : true,
  "inheritable" : true,
  "id" : 12345,
  "name" : "...",
  "constructId" : 12345,
  "categoryId" : 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" : "BOOLEAN",
      "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" : "ORDEREDLIST",
      "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" : "ABOVE",
    "editorControlsInside" : true,
    "categoryId" : 12345
  },
  "active" : true,
  "categoryName" : "...",
  "properties" : {
    "property1" : {
      "type" : "TABLE",
      "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" : "PAGE",
        "selectType" : "AUTO",
        "orderDirection" : "ASC",
        "orderBy" : "SELF",
        "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" : "..."
    },
    "property2" : {
      "type" : "NODE",
      "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" : "PAGE",
        "selectType" : "MANUAL",
        "orderDirection" : "UNDEFINED",
        "orderBy" : "SELF",
        "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" : "..."
    }
  },
  "type" : "TEMPLATETAG",
  "sortOrder" : 12345,
  "readOnly" : true,
  "rootTag" : true,
  "inherited" : true
}