v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Inventory Relationships V1

Get Inventory Links

Use this API to list an existing links between an inventory and one or more other inventories of a given type.

get/api/inventory/v2/inventories/{id}/relations/{inventoryType}

Path parameters

idstring uuid required

The unique identifier of an inventory record. The value can be obtained using the List Inventories API.

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

The type of inventory records to check relations for.

Query parameters

pageinteger

Results page to be retrieved (0..N)

sizeinteger

Number of records per page (1..50)

Response

OK

inventoryIdstring uuid

The unique identifier of the linked inventory record

inventoryAssociationIdstring uuid

The unique identifier of the association between inventory records

Example response

[
  {
    "inventoryId": "9a7c3ec1-7830-4811-8563-36e0a093e7ae",
    "inventoryAssociationId": "4374d5da-44ac-4308-a298-3efdb0f34ba4"
  }
]