Skip to main content

NodeGetCanonicalByEntryOptions

Log in to add to favourites

NodeGetCanonicalByEntryOptions is a structure that is used to describe the options for requesting the canonical node assigned to an entry.

Properties

NameTypeDescription
entryIdstringThe entry id to find the canonical node for
entryEntryThe entry (containing the id) to find the canonical node for
canonicalOnlytrueMust be true in order to return the canonical node
depthnumberThe depth of descendants to include for the node. The default is 0. Also canonicalOnly must be true to use depth
languagestringThe optional language for the node. If no value is provided then the project default language is used.
entryFieldLinkDepths{ string: number }Object containing field paths to resolve linked entries for and the link depth to resolve the field to
entryFieldsstring[]The optional list of fields that will be retrieved if the node has an entry attached to it.
entryLinkDepthnumberThe 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.

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