HTTP - Delivery

Node

Created by Contensis product team, last updated 09 Jul 2020

A node represents a location within the navigational structure of a website. The linking of nodes as parent-child relationships forms the hierarchical structure of a website, with a node having a single parent and (optionally) multiple child nodes.

A single entry can be assigned to a node, separating the responsibility of navigation management from content editing.

Properties

Name	Data type	Data format	Description
id	string	uuid	The node identifier as a 128 bit GUID
parentId	string	uuid	The identifier of the parent node as a 128 bit GUID
projectId	string		The friendly name given to the project
displayName	object	localized value	The localised displayName of the node
slug	object	localized value	The localised displayName of the node
entryId	string	uuid	The identifier of the referenced entry as a 128 bit GUID
restrictedToLanguages	string[...]		An array of all the languages supported by the node
childCount	number		The count of child nodes
isCanonical	boolean		true if the node represents the canonical path for the associated entry; false otherwise
includeInMenu	boolean		rue if the node should be included in menus; false otherwise. Defaults to true. Does not stop the node from being navigable
language	string	language	The language that the node represents
path	string	URI	The path of the node
version.versionNo	string		The version number of the node
Entry	object	entry	The entry associated with the node, if requested
children	object[...]	node	If a depth is specified when requesting a node then the children field would include the descendant nodes to the specified depth

Example

{
    "id": "3B9CCCD6-D0F9-4FA7-BE8F-62A3EDCCA2DD",
    "parentId": "EFD16C0D-DE03-4D29-B979-76E20F9F1642",
    "projectId": "movieDb",
    "slug": "last-action-hero",
    "displayName": "The Last Action Hero",
    "isCanonical": true,
    "language": "en-GB",
    "path": "/en-GB/movies/action/last-action-hero",
    "childCount": 10,
    "children": [],
    "entry": {
        "sys": {
            "id": "e6976206-a488-45e3-a438-244b871f48c0"
        }
    },
    "version": {
        "versionNo": "1.0"
    },
    "includeInMenu": true
}