HTTP - Delivery
Get nodes by entry id
Created by Contensis product team, last updated 22 Jun 2020
Gets all nodes that have the specified entry assigned, if canonicalOnly is set to true then only the canonical node for the given entry is returned.
GET/api/delivery/projects/{projectId}/nodes/?entryId={entryId}
Parameters
Name | Parameter type | Type | Format | Description | Example | Required |
---|---|---|---|---|---|---|
projectId | path | string | The project identifier found in the project overview screen of the management console | movieDb | true | |
entryId | query | string | uuid | The entry identifier as a 128 bit GUID | true | |
language | query | string | language | The specified language for the node. If no value is provided then the project primary language is used | false | |
depth | query | number | The depth of descendants to include for the node. The default is 0. This parameter only has an effect if canonicalOnly has a value of true | false | ||
versionStatus | query | string | The status of the associated entry, either published or latest. The default is published | false | ||
entryFields | query | string | A comma separated list of entry fields to include in the entry response. Specify * to include all entry fields | false | ||
entryLinkDepth | query | number | The depth at which to resolve the full entry data for a linked entry or asset, with a maximum depth value of 10 | false | ||
canonicalOnly | query | boolean | If canonicalOnly is true then just the canonical (default location) node is returned, otherwise a list of all nodes attached to the specified entry are returned | false |
Example
GET: /api/delivery/projects/movieDb/nodes/?entryId=d014533c-2f4e-4f73-b9f5-ff107755080b&language=en-GB&depth=1&versionStatus=latest
Responses
HTTP status code | Reason | Model |
---|---|---|
200 | Success when canonicalOnly is not set or is false | Node [...] |
200 | Success when canonicalOnly is true | Node |
404 | Project not found | Error |
404 | Node not found | Error |
500 | Internal server error | Error |