ONonetrust
inventory-management-controller

Get Inventory IDs from Business Keys

Use this API to retrieve inventory IDs for the given business keys and schema type.

Example Request

POST https://{hostname}/api/inventory/v2/inventories/processing-activities/business-keys

POST https://trial.onetrust.com/api/inventory/v2/inventories/processing-activities/business-keys

post/api/inventory/v2/inventories/{schemaName}/business-keys

Request

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

Path parameters

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

The name property of the schema. The value can be obtained using the Get Schemas API.

Query parameters

orgGroupIdstring uuid

The organization group ID to scope the search

Request body

string[] required

Response

OK - Successfully retrieved inventory IDs for the given business keys.

businessKeystring required
inventoryIdstring uuid

Changes

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