---
title: "POST /navigate"
method: POST
path: "/navigate"
tags: ["Discovery"]
---

# POST /navigate

`POST /navigate`

Navigate entities by itemPath.

## Query parameters

- `maxpagesize` integer
- `continuationToken` string
- `api-version` string, required

## Request body

- NavigationRequest — The request payload of Navigation API.
  - `navigationMode` 'assetType' | 'azureResourceHierarchy' — The navigation mode.
  - `itemPath` ItemPath, required — The identifier of navigation request.
    - `path` string, required — The identifier of the item. The path starts with an empty string or a single slash. To navigate further, you need to concatenate with a slash to form the full itemPath using the previous navigation response's relative item path.
    - `extendedProperties` object — The extended properties of the itemPath are typically obtained from the last navigation response. While not mandatory to provide, including them can enhance performance. Otherwise, there may be some impact on performance.
  - `properties` object — Additional properties of the item.
  - `includeNextLevelAssetCount` boolean — Whether to return the next level asset count.

## Response `200`

OK. On successful get the entities.

- NavigationResult — The response payload of the Navigation API.
  - `items` NavigationItem[], required
    - `name` string, required — The name of the item.
    - `type` string, required — The type name of the item. Eg. EntityType.
    - `isLeafNode` boolean, required — Indicates whether the item is a leaf node. If it is, further navigation is not possible.
    - `isEntity` boolean, required — Whether the item is Entity. If yes, can get complete definition of an entity given its itemPath
    - `itemPath` ItemPath, required — The identifier of navigation request.
      - `path` string, required — The identifier of the item. The path starts with an empty string or a single slash. To navigate further, you need to concatenate with a slash to form the full itemPath using the previous navigation response's relative item path.
      - `extendedProperties` object — The extended properties of the itemPath are typically obtained from the last navigation response. While not mandatory to provide, including them can enhance performance. Otherwise, there may be some impact on performance.
    - `count` integer — The count of the top level asset. Won't return if request payload 'includeNextLevelAssetCount' is false.
    - `properties` object, required — The additional properties of the navigation element.
  - `continuationToken` string — The token used to get next batch of data. Absent if there's no more data.

## Other responses

- `default` — Error response describing why the operation failed.

---

[API](https://skmtc.net/azure/apis/purview-datamap.md) · [All operations](https://skmtc.net/azure/apis/purview-datamap/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/azure/purview-datamap/revisions/442226cb14a9/schema)