Skip to main content

NodeGetByPathOptions

Log in to add to favourites

NodeGetByPathOptions is a structure that is used to describe the options for requesting a node by path

Properties

NameTypeDescription
pathstringThe node path.
language?stringThe optional language for the node. If no value is provided then the project default language is used.
depth?numberThe depth of descendants to include for the node. The default is 0. This reduces calls to the HTTP service and improves performance.
entryFieldLinkDepths?{ string: number }Object containing field paths to resolve linked entries for and the link depth to resolve the field to
entryFields?string[]The optional list of fields that will be retrieved if the node has an entry attached to it.
entryLinkDepth?numberThe depth at which to resolve the full entry data for a linked entry or asset, with a maximum depth value of 10. The default is 0.
allowPartialMatch?boolean[Optional] When set to true, returns the nearest ancestor up to, but not including, root on the path if the node at the specified path does not exist.

Still need help?

If you still need help after reading this article, don't hesitate to reach out to the Contensis community on Slack or raise a support ticket to get help from our team.
New support request