ContentPackageFolder Data Type

REST API folder entity for Content Staging.

Properties
name data type description
errors array of StagedError
Properties inherited from StagedFolder
publishDir string Publish directory of the folder
description string Description
objectTags map of StagedObjectTag Map of object tags of the folder
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)
publishDirI18n map of string Map of translated publish directories (keys are the language codes)
templateIds array of string IDs of assigned templates
Properties inherited from StagedLocalizableObject
masterId string
disinheritedChannelIds array of string
disinheritDefault boolean
excluded boolean
Properties inherited from StagingBase
name string
id string

Example

{
  "errors" : [ {
    "error" : "...",
    "kind" : "EXCEPTION"
  }, {
    "error" : "...",
    "kind" : "EXCEPTION"
  } ],
  "publishDir" : "...",
  "description" : "...",
  "objectTags" : {
    "property1" : {
      "definition" : {
        "id" : "...",
        "hash" : "..."
      },
      "name" : "...",
      "construct" : {
        "id" : "...",
        "hash" : "..."
      },
      "active" : true,
      "properties" : {
        "property1" : {
          "type" : "PAGE",
          "id" : "...",
          "partId" : "...",
          "stringValue" : "...",
          "booleanValue" : true,
          "fileId" : "...",
          "imageId" : "...",
          "folderId" : "...",
          "pageId" : "...",
          "templateId" : "...",
          "contentTagId" : "...",
          "templateTagId" : "...",
          "nodeId" : "...",
          "formId" : "...",
          "stringValues" : [ "...", "..." ],
          "options" : [ { }, { } ],
          "selectedOptions" : [ { }, { } ],
          "datasource" : { },
          "overview" : { },
          "hash" : "...",
          "name" : "..."
        },
        "property2" : {
          "type" : "TABLE",
          "id" : "...",
          "partId" : "...",
          "stringValue" : "...",
          "booleanValue" : true,
          "fileId" : "...",
          "imageId" : "...",
          "folderId" : "...",
          "pageId" : "...",
          "templateId" : "...",
          "contentTagId" : "...",
          "templateTagId" : "...",
          "nodeId" : "...",
          "formId" : "...",
          "stringValues" : [ "...", "..." ],
          "options" : [ { }, { } ],
          "selectedOptions" : [ { }, { } ],
          "datasource" : { },
          "overview" : { },
          "hash" : "...",
          "name" : "..."
        }
      },
      "type" : "CONTENTTAG",
      "id" : "..."
    },
    "property2" : {
      "definition" : {
        "id" : "...",
        "hash" : "..."
      },
      "name" : "...",
      "construct" : {
        "id" : "...",
        "hash" : "..."
      },
      "active" : true,
      "properties" : {
        "property1" : {
          "type" : "NAVIGATION",
          "id" : "...",
          "partId" : "...",
          "stringValue" : "...",
          "booleanValue" : true,
          "fileId" : "...",
          "imageId" : "...",
          "folderId" : "...",
          "pageId" : "...",
          "templateId" : "...",
          "contentTagId" : "...",
          "templateTagId" : "...",
          "nodeId" : "...",
          "formId" : "...",
          "stringValues" : [ "...", "..." ],
          "options" : [ { }, { } ],
          "selectedOptions" : [ { }, { } ],
          "datasource" : { },
          "overview" : { },
          "hash" : "...",
          "name" : "..."
        },
        "property2" : {
          "type" : "UNORDEREDLIST",
          "id" : "...",
          "partId" : "...",
          "stringValue" : "...",
          "booleanValue" : true,
          "fileId" : "...",
          "imageId" : "...",
          "folderId" : "...",
          "pageId" : "...",
          "templateId" : "...",
          "contentTagId" : "...",
          "templateTagId" : "...",
          "nodeId" : "...",
          "formId" : "...",
          "stringValues" : [ "...", "..." ],
          "options" : [ { }, { } ],
          "selectedOptions" : [ { }, { } ],
          "datasource" : { },
          "overview" : { },
          "hash" : "...",
          "name" : "..."
        }
      },
      "type" : "CONTENTTAG",
      "id" : "..."
    }
  },
  "nameI18n" : {
    "property1" : "...",
    "property2" : "..."
  },
  "descriptionI18n" : {
    "property1" : "...",
    "property2" : "..."
  },
  "publishDirI18n" : {
    "property1" : "...",
    "property2" : "..."
  },
  "templateIds" : [ "...", "..." ],
  "masterId" : "...",
  "disinheritedChannelIds" : [ "...", "..." ],
  "disinheritDefault" : true,
  "excluded" : true,
  "name" : "...",
  "id" : "..."
}