REST Model for a Node
| name | data type | constraints | description |
|---|---|---|---|
| id | number | ID of the item | |
| globalId | string | Global ID of the item | |
| name | string | Name of the item | |
| creator | User | read-only | Creator of the item |
| folderId | number | read-only int | ID of the root folder |
| cdate | number | required int, read-only int | Creation date of the item as unix timestamp |
| editor | User | read-only | Last editor of the item |
| publishDir | string | Publish directory | |
| edate | number | required int, read-only int | Last Edit Date of the item as unix timestamp |
| type | ItemType | read-only | Item type |
| binaryPublishDir | string | Publish directory for binaries | |
| pubDirSegment | boolean | True if the publish directories are created from segments defined for the folders. False if every folder has its own publish directory. | |
| deleted | DeleteInfo | read-only | Deletion information, if object was deleted |
| publishImageVariants | boolean | True if image variants should be created on page/object property publish | |
| host | string | Hostname of the node | |
| masterDeleted | DeleteInfo | read-only | Deletion information about the master (if the object is not a master itself). |
| hostProperty | string | Property containing the hostname. This can be set to a system property or environment variable in the format ${sys:property} or ${env:variable}. | |
| folderDeleted | DeleteInfo | read-only | Deletion information about the containing folder. |
| |
|
|
|
| publishFs | boolean | True if the node shall publish into the filesystem | |
| publishFsPages | boolean | True if the node shall publish pages into the file system | |
| publishFsFiles | boolean | True if the node shall publish files into the file system | |
| publishContentMap | boolean | True if the node shall publish into a contentmap (if a contentrepository is assigned) | |
| publishContentMapPages | boolean | True if to publish pages to the content repository | |
| publishContentMapFiles | boolean | True if to publish files to the content repository | |
| publishContentMapFolders | boolean | True if to publish folders to the content repository | |
| contentRepositoryId | number | ID of the assigned contentrepository | |
| disablePublish | boolean | True if publishing content modifications is disabled | |
| editorVersion | number | Editor to be used in the node Possible values are 0 for LiveEditor and 1 for Aloha editor. | |
| contentEditor | Editor | Editor to be used in the node. Note: This field is here for backward compatibility reasons, the preferred way to get the editor is getEditorVersion. | |
| defaultFileFolderId | number | Default File Upload Folder ID | |
| defaultImageFolderId | number | Default Image Upload Folder ID | |
| languagesId | array of number | Ordered list of IDs of the languages assigned to the node | |
| masterId | number | The id of the master node if this is a channel. | |
| inheritedFromId | number | read-only int | ID of the node or channel from which this node inherits from directly (immediate master node) |
| inheritedFromName | string | read-only | Name of the node or channel this channel inherits from directly (immediate master node) |
| masterNodeId | number | read-only int | ID of the top master node of the node. The id will point to the node itself if there is no specific master. |
| urlRenderWayPages | number | How URLs are rendered for pages in this node | |
| urlRenderWayFiles | number | How URLs are rendered for files in this node | |
| meshPreviewUrl | string | Preview URL of Mesh Portal. | |
| meshPreviewUrlProperty | string | Property containing the preview URL. This can be set to a system property or environment variable in the format ${sys:property} or ${env:variable}. | |
| insecurePreviewUrl | boolean | Whether insecure connections to the preview URL are allowed. | |
| meshProject | string | read-only | Mesh Project, this node publishes into |
| meshProjectName | string | ||
| omitPageExtension | boolean | True to omit page extensions when generating filenames of pages | |
| pageLanguageCode | PageLanguageCode | Setting for placement of language codes for pages | |
| masterName | string | read-only | Name of the master node, if this node is a channel |
| contentRepositoryName | string | read-only | Name of the content repository assigned to the node |
Example
{
"id" : 12345,
"globalId" : "...",
"name" : "...",
"creator" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ {
"id" : 12345,
"name" : "...",
"description" : "...",
"children" : [ { }, { } ]
}, {
"id" : 12345,
"name" : "...",
"description" : "...",
"children" : [ { }, { } ]
} ],
"login" : "...",
"password" : "..."
},
"folderId" : 12345,
"cdate" : 12345,
"editor" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ {
"id" : 12345,
"name" : "...",
"description" : "...",
"children" : [ { }, { } ]
}, {
"id" : 12345,
"name" : "...",
"description" : "...",
"children" : [ { }, { } ]
} ],
"login" : "...",
"password" : "..."
},
"publishDir" : "...",
"edate" : 12345,
"type" : "file",
"binaryPublishDir" : "...",
"pubDirSegment" : true,
"deleted" : {
"at" : 12345,
"by" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
}
},
"publishImageVariants" : true,
"host" : "...",
"masterDeleted" : {
"at" : 12345,
"by" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
}
},
"hostProperty" : "...",
"folderDeleted" : {
"at" : 12345,
"by" : {
"id" : 12345,
"firstName" : "...",
"lastName" : "...",
"description" : "...",
"email" : "...",
"groups" : [ { }, { } ],
"login" : "...",
"password" : "..."
}
},
"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,
"inheritedFromName" : "...",
"masterNodeId" : 12345,
"urlRenderWayPages" : 12345,
"urlRenderWayFiles" : 12345,
"meshPreviewUrl" : "...",
"meshPreviewUrlProperty" : "...",
"insecurePreviewUrl" : true,
"meshProject" : "...",
"meshProjectName" : "...",
"omitPageExtension" : true,
"pageLanguageCode" : "NONE",
"masterName" : "...",
"contentRepositoryName" : "..."
}