Folder Data Type

Folder object, representing a Folder in GCN

Properties
name data type description
inheritedFrom string Name of the node this folder is inherited from
inheritedFromId number Id of the node this folder is inherited from.
masterNode string Name of the node, the master object belongs to
masterNodeId number Return the id of the node, the master object belongs to.
motherId number Mother id of the folder
publishDir string Publish directory of the folder
description string Description
nodeId number Node id
inherited boolean True if the folder is inherited, false if not
atposidx string Position of the folder in the folder tree
startPageId object ID of the startpage
tags map of Tag Map of object tags of the folder
subfolders array of Folder List of subfolders
hasSubfolders boolean True if the folder has subfolders (regardless of whether they have been fetched), false if not
privileges array of Privilege Folder privileges
privilegeBits string Privilege bits
privilegeMap PrivilegeMap Map representation of all privileges
path string Folder path of this folder
masterId number Master ID. The master is the next folder up in the channel hierarchy with the same Channelset ID. The Master ID is 0 if there is no master. Read only.
channelsetId number Channelset ID. All copies of the same folder in different channels share the same Channelset ID. Read only.
channelId number Channel ID. It identifies different versions of the same folder in different channels. Equals to the node id for which the folder is defined, or to 0 if it is defined in the topost node of the channel hierarchy. Read only.
isMaster boolean True if the folder is a master, false otherwise. A folder is a master if it isn't a localized copy of another folder. Read only.
disinheritedChannels array of Node the set of disinherited channels for this object
excluded boolean Whether this folder is excluded from multichannelling.
disinheritDefault boolean Whether this folder is disinherited by default in new channels.
disinherited boolean True if the folder is disinherited in some channels
meshProject string Mesh Project, this node publishes into. This will only be set for root folders
Properties inherited from ContentNodeItem
id number ID of the item
globalId string Global ID of the item
name string Name of the item
creator User Creator of the item
cdate number Creation date of the item
editor User Last editor of the item
edate number Last Edit Date of the item
type ItemType Item type
deleted DeleteInfo Deletion information, if object was deleted
masterDeleted DeleteInfo Deletion information about the master (if the object is not a master itself).
folderDeleted DeleteInfo Deletion information about the containing folder.

Example

{
  "inheritedFrom" : "...",
  "inheritedFromId" : 12345,
  "masterNode" : "...",
  "masterNodeId" : 12345,
  "motherId" : 12345,
  "publishDir" : "...",
  "description" : "...",
  "nodeId" : 12345,
  "inherited" : true,
  "atposidx" : "...",
  "startPageId" : { },
  "tags" : {
    "property1" : {
      "id" : 12345,
      "name" : "...",
      "constructId" : 12345,
      "active" : true,
      "properties" : {
        "property1" : {
          "type" : "ORDEREDLIST",
          "stringValue" : "...",
          "booleanValue" : true,
          "fileId" : 12345,
          "imageId" : 12345,
          "folderId" : 12345,
          "pageId" : 12345,
          "stringValues" : [ "...", "..." ],
          "options" : [ { }, { } ],
          "selectedOptions" : [ { }, { } ],
          "datasourceId" : 12345,
          "overview" : { },
          "templateId" : 12345,
          "contentTagId" : 12345,
          "templateTagId" : 12345,
          "nodeId" : 12345,
          "partId" : 12345,
          "id" : 12345,
          "globalId" : "..."
        },
        "property2" : {
          "type" : "FILE",
          "stringValue" : "...",
          "booleanValue" : true,
          "fileId" : 12345,
          "imageId" : 12345,
          "folderId" : 12345,
          "pageId" : 12345,
          "stringValues" : [ "...", "..." ],
          "options" : [ { }, { } ],
          "selectedOptions" : [ { }, { } ],
          "datasourceId" : 12345,
          "overview" : { },
          "templateId" : 12345,
          "contentTagId" : 12345,
          "templateTagId" : 12345,
          "nodeId" : 12345,
          "partId" : 12345,
          "id" : 12345,
          "globalId" : "..."
        }
      },
      "type" : "TEMPLATETAG"
    },
    "property2" : {
      "id" : 12345,
      "name" : "...",
      "constructId" : 12345,
      "active" : true,
      "properties" : {
        "property1" : {
          "type" : "TABLE",
          "stringValue" : "...",
          "booleanValue" : true,
          "fileId" : 12345,
          "imageId" : 12345,
          "folderId" : 12345,
          "pageId" : 12345,
          "stringValues" : [ "...", "..." ],
          "options" : [ { }, { } ],
          "selectedOptions" : [ { }, { } ],
          "datasourceId" : 12345,
          "overview" : { },
          "templateId" : 12345,
          "contentTagId" : 12345,
          "templateTagId" : 12345,
          "nodeId" : 12345,
          "partId" : 12345,
          "id" : 12345,
          "globalId" : "..."
        },
        "property2" : {
          "type" : "FILE",
          "stringValue" : "...",
          "booleanValue" : true,
          "fileId" : 12345,
          "imageId" : 12345,
          "folderId" : 12345,
          "pageId" : 12345,
          "stringValues" : [ "...", "..." ],
          "options" : [ { }, { } ],
          "selectedOptions" : [ { }, { } ],
          "datasourceId" : 12345,
          "overview" : { },
          "templateId" : 12345,
          "contentTagId" : 12345,
          "templateTagId" : 12345,
          "nodeId" : 12345,
          "partId" : 12345,
          "id" : 12345,
          "globalId" : "..."
        }
      },
      "type" : "OBJECTTAG"
    }
  },
  "subfolders" : [ {
    "inheritedFrom" : "...",
    "inheritedFromId" : 12345,
    "masterNode" : "...",
    "masterNodeId" : 12345,
    "motherId" : 12345,
    "publishDir" : "...",
    "description" : "...",
    "nodeId" : 12345,
    "inherited" : true,
    "atposidx" : "...",
    "startPageId" : { },
    "tags" : {
      "property1" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "CONTENTTAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "OBJECTTAG"
      }
    },
    "subfolders" : [ { }, { } ],
    "hasSubfolders" : true,
    "privileges" : [ "updatepage", "linktemplate" ],
    "privilegeBits" : "...",
    "privilegeMap" : {
      "privileges" : {
        "property1" : true,
        "property2" : true
      },
      "languages" : [ { }, { } ]
    },
    "path" : "...",
    "masterId" : 12345,
    "channelsetId" : 12345,
    "channelId" : 12345,
    "isMaster" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "LiveEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "meshProject" : "...",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "channel",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "AlohaEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "meshProject" : "...",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "folder",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "meshProject" : "...",
    "id" : 12345,
    "globalId" : "...",
    "name" : "...",
    "creator" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "cdate" : 12345,
    "editor" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "edate" : 12345,
    "type" : "channel",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  }, {
    "inheritedFrom" : "...",
    "inheritedFromId" : 12345,
    "masterNode" : "...",
    "masterNodeId" : 12345,
    "motherId" : 12345,
    "publishDir" : "...",
    "description" : "...",
    "nodeId" : 12345,
    "inherited" : true,
    "atposidx" : "...",
    "startPageId" : { },
    "tags" : {
      "property1" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "CONTENTTAG"
      },
      "property2" : {
        "id" : 12345,
        "name" : "...",
        "constructId" : 12345,
        "active" : true,
        "properties" : {
          "property1" : { },
          "property2" : { }
        },
        "type" : "TEMPLATETAG"
      }
    },
    "subfolders" : [ { }, { } ],
    "hasSubfolders" : true,
    "privileges" : [ "createpage", "deletepage" ],
    "privilegeBits" : "...",
    "privilegeMap" : {
      "privileges" : {
        "property1" : true,
        "property2" : true
      },
      "languages" : [ { }, { } ]
    },
    "path" : "...",
    "masterId" : 12345,
    "channelsetId" : 12345,
    "channelId" : 12345,
    "isMaster" : true,
    "disinheritedChannels" : [ {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "LiveEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "meshProject" : "...",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "file",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    }, {
      "folderId" : 12345,
      "publishDir" : "...",
      "binaryPublishDir" : "...",
      "pubDirSegment" : true,
      "https" : true,
      "host" : "...",
      "utf8" : true,
      "publishFs" : true,
      "publishFsPages" : true,
      "publishFsFiles" : true,
      "publishContentMap" : true,
      "publishContentMapPages" : true,
      "publishContentMapFiles" : true,
      "publishContentMapFolders" : true,
      "contentRepositoryId" : 12345,
      "disablePublish" : true,
      "editorVersion" : 12345,
      "contentEditor" : "AlohaEditor",
      "defaultFileFolderId" : 12345,
      "defaultImageFolderId" : 12345,
      "languagesId" : [ 12345, 12345 ],
      "masterId" : 12345,
      "inheritedFromId" : 12345,
      "masterNodeId" : 12345,
      "urlRenderWayPages" : 12345,
      "urlRenderWayFiles" : 12345,
      "meshPreviewUrl" : "...",
      "meshProject" : "...",
      "id" : 12345,
      "globalId" : "...",
      "name" : "...",
      "creator" : { },
      "cdate" : 12345,
      "editor" : { },
      "edate" : 12345,
      "type" : "channel",
      "deleted" : { },
      "masterDeleted" : { },
      "folderDeleted" : { }
    } ],
    "excluded" : true,
    "disinheritDefault" : true,
    "disinherited" : true,
    "meshProject" : "...",
    "id" : 12345,
    "globalId" : "...",
    "name" : "...",
    "creator" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "cdate" : 12345,
    "editor" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "edate" : 12345,
    "type" : "folder",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  } ],
  "hasSubfolders" : true,
  "privileges" : [ "translatepage", "linktemplate" ],
  "privilegeBits" : "...",
  "privilegeMap" : {
    "privileges" : {
      "property1" : true,
      "property2" : true
    },
    "languages" : [ {
      "language" : { },
      "privileges" : {
        "property1" : true,
        "property2" : true
      }
    }, {
      "language" : { },
      "privileges" : {
        "property1" : true,
        "property2" : true
      }
    } ]
  },
  "path" : "...",
  "masterId" : 12345,
  "channelsetId" : 12345,
  "channelId" : 12345,
  "isMaster" : true,
  "disinheritedChannels" : [ {
    "folderId" : 12345,
    "publishDir" : "...",
    "binaryPublishDir" : "...",
    "pubDirSegment" : true,
    "https" : true,
    "host" : "...",
    "utf8" : true,
    "publishFs" : true,
    "publishFsPages" : true,
    "publishFsFiles" : true,
    "publishContentMap" : true,
    "publishContentMapPages" : true,
    "publishContentMapFiles" : true,
    "publishContentMapFolders" : true,
    "contentRepositoryId" : 12345,
    "disablePublish" : true,
    "editorVersion" : 12345,
    "contentEditor" : "AlohaEditor",
    "defaultFileFolderId" : 12345,
    "defaultImageFolderId" : 12345,
    "languagesId" : [ 12345, 12345 ],
    "masterId" : 12345,
    "inheritedFromId" : 12345,
    "masterNodeId" : 12345,
    "urlRenderWayPages" : 12345,
    "urlRenderWayFiles" : 12345,
    "meshPreviewUrl" : "...",
    "meshProject" : "...",
    "id" : 12345,
    "globalId" : "...",
    "name" : "...",
    "creator" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "cdate" : 12345,
    "editor" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "edate" : 12345,
    "type" : "file",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  }, {
    "folderId" : 12345,
    "publishDir" : "...",
    "binaryPublishDir" : "...",
    "pubDirSegment" : true,
    "https" : true,
    "host" : "...",
    "utf8" : true,
    "publishFs" : true,
    "publishFsPages" : true,
    "publishFsFiles" : true,
    "publishContentMap" : true,
    "publishContentMapPages" : true,
    "publishContentMapFiles" : true,
    "publishContentMapFolders" : true,
    "contentRepositoryId" : 12345,
    "disablePublish" : true,
    "editorVersion" : 12345,
    "contentEditor" : "AlohaEditor",
    "defaultFileFolderId" : 12345,
    "defaultImageFolderId" : 12345,
    "languagesId" : [ 12345, 12345 ],
    "masterId" : 12345,
    "inheritedFromId" : 12345,
    "masterNodeId" : 12345,
    "urlRenderWayPages" : 12345,
    "urlRenderWayFiles" : 12345,
    "meshPreviewUrl" : "...",
    "meshProject" : "...",
    "id" : 12345,
    "globalId" : "...",
    "name" : "...",
    "creator" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "cdate" : 12345,
    "editor" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    },
    "edate" : 12345,
    "type" : "page",
    "deleted" : {
      "at" : 12345,
      "by" : { }
    },
    "masterDeleted" : {
      "at" : 12345,
      "by" : { }
    },
    "folderDeleted" : {
      "at" : 12345,
      "by" : { }
    }
  } ],
  "excluded" : true,
  "disinheritDefault" : true,
  "disinherited" : true,
  "meshProject" : "...",
  "id" : 12345,
  "globalId" : "...",
  "name" : "...",
  "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,
  "type" : "file",
  "deleted" : {
    "at" : 12345,
    "by" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    }
  },
  "masterDeleted" : {
    "at" : 12345,
    "by" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    }
  },
  "folderDeleted" : {
    "at" : 12345,
    "by" : {
      "id" : 12345,
      "firstName" : "...",
      "lastName" : "...",
      "description" : "...",
      "email" : "...",
      "groups" : [ { }, { } ],
      "login" : "...",
      "password" : "..."
    }
  }
}