Jump to

• Request
• Response

Get the navigation by node identifier

get

/resources/v1/aggregates/{siteName}/navigation/{nodeIdentifier}

The resource endpoint returns the navigation data for a given node identifier in a site name.

Important Note: It is a Singular Resource. The response is in an aggregated asset format (refer to the note in Asset Resource end point). It is similar to Asset Resource end point except in addition to asset info, it also gives navigation data. So all the aggregate asset query params (assetDepth, expand, fields, segments, profileName) are also applicable to this resource. All the navigation data (child nodes w.r.t navigation) is available in the 'children' array in the response. Each child is again an aggregated asset. The given aggregate asset query params are also applied to each child in the children array.

Request

Path Parameters

• nodeIdentifier: integer(double)
  Site node ID or the site navigation name
• siteName: string
  Name of the site

Query Parameters

• assetDepth: number
  To know about this parameter, refer to the 'assetDepth' query param in Asset Resource. Applicable to each child in the children array also.
• code: string
  Accepts a comma-separated list of site node types. Determines whether placed or unplaced children nodes (pages) under a publication are to be returned. The default node type is placed. This is applicable only for a publication node (that is, nodeIdentifier is a publication ID).
  Usage:

  • "code=unplaced". It means to include only unplaced children in the response.
  • "code=placed,unplaced". It means to include both placed and unplaced children in the response.
• expand: string
  Accepts a comma-separated list of assetTypes. To know more about this parameter, refer to the 'expand' query param in Asset Resource. Applicable to each child in the children array also.
• fields: string
  To know about this parameter, refer to the 'fields' query param in Asset Resource. Applicable to each child in the children array also. The 'children' array cannot be filtered out from the response.
• links: string
  Accepts a comma-separated list of link names. By default, this parameter gives all the links (schema, self, and canonical resources).
• navigationDepth: number
  Accepts any positive integer or the string "all". The navigation depth as an integer defines the children level to which to traverse the site navigation. The string "all" refers to the full depth. The default value is 2. In case of an invalid navigationDepth value (negative number), the default navigationDepth value is used. The children of a node are available in a children array. This children attribute cannot be filtered out. Each children item is again aggregated, and all the query parameters of the aggregated asset are applicable to each item.
• profileName: string
  To know about this parameter, refer to the 'profileName' query param in Asset Resource. Applicable to each child in the children array also.
• segments: string
  To know about this parameter, refer to the 'segments' query param in Asset Resource. Applicable to each child in the children array also.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Site navigation data in aggregated format

Back to Top