Inventory Hierarchies

Get List of Child Inventories by Root Inventory

Use this API to provide a paginated list of Child Inventories for a given Inventory Schema Type and a Root Inventory Id.

get/api/inventory/v2/inventory-hierarchies/{rootInventoryId}

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/api/inventory/v2/inventory-hierarchies/{rootInventoryId}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: INVENTORY, INVENTORY_READ, INVENTORY_WRITE

Path parameters

rootInventoryIdstring uuid required

The unique identifier of the root inventory

Query parameters

inventoryType'processing-activities' | 'vendors' | 'assets' | 'entities' required

The type of inventory (e.g., assets, vendors, processing-activities, legal-entities)

pageinteger

Results page to be retrieved (0..N)

sizeinteger

Number of records per page (1..50)

sort'name,asc' | 'name,desc' | 'createdDate,asc' | 'createdDate,desc'

Sorting criteria in the format: property(,asc|desc). Default sort order is ascending

Response

OK

string required

Changes

No recorded changes to this operation across all 1 revision of this API.