folder

Extends: contentNodeItem
Namespace: http://www.gentics.com/rest
XML Schema: ns0.xsd

Folder object, representing a Folder in GCN

XML

Elements

name (type) min/max
occurs
description
excluded (boolean) 0/1 Whether this folder is excluded from multichannelling.
disinheritDefault (boolean) 0/1 Whether this folder is disinherited by default in new channels.
disinherited (boolean) 0/1 Whether this folder is disinherited in some channels
inheritedFrom (string) 0/1 Name of the node this folder is inherited from
masterNode (string) 0/1 Name of the node, the master object belongs to
motherId (int) 0/1 Mother id of the folder
publishDir (string) 0/1 Publish directory of the folder
description (string) 0/1 Description
nodeId (int) 0/1 Node id
inherited (boolean) 1/1 True if the folder is inherited, false if not
atposidx (string) 0/1 Position of the folder in the folder tree
startPageId (anyType) 0/1 ID of the startpage
tags ((anonymous)) 0/1 Map of object tags of the folder
subfolders (folder) 0/unbounded List of subfolders
hasSubfolders (boolean) 1/1 True if the folder has subfolders (regardless of whether they have been fetched), false if not
privileges (privilege) 0/unbounded Folder privileges
privilegeBits (string) 0/1 Privilege bits
path (string) 0/1 Folder path of this folder
masterId (int) 0/1 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 (int) 0/1 Channelset ID. All copies of the same folder in different channels share the same Channelset ID. Read only.
channelId (int) 0/1 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) 0/1 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 (node) 0/unbounded the set of disinherited channels for this object

JSON

property type description
excluded excluded (boolean) Whether this folder is excluded from multichannelling.
disinheritDefault disinheritDefault (boolean) Whether this folder is disinherited by default in new channels.
disinherited disinherited (boolean) Whether this folder is disinherited in some channels
inheritedFrom inheritedFrom (string) Name of the node this folder is inherited from
masterNode masterNode (string) Name of the node, the master object belongs to
motherId motherId (int) Mother id of the folder
publishDir publishDir (string) Publish directory of the folder
description description (string) Description
nodeId nodeId (int) Node id
inherited inherited (boolean) True if the folder is inherited, false if not
atposidx atposidx (string) Position of the folder in the folder tree
startPageId startPageId (anyType) ID of the startpage
tags tags ((anonymous)) Map of object tags of the folder
subfolders array of subfolders (folder) List of subfolders
hasSubfolders hasSubfolders (boolean) True if the folder has subfolders (regardless of whether they have been fetched), false if not
privileges array of privileges (privilege) Folder privileges
privilegeBits privilegeBits (string) Privilege bits
path path (string) Folder path of this folder
masterId masterId (int) 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 channelsetId (int) Channelset ID. All copies of the same folder in different channels share the same Channelset ID. Read only.
channelId channelId (int) 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 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 disinheritedChannels (node) the set of disinherited channels for this object