ONonetrust
Inventory

Update Inventory Status

Use this API to change the existing status of an inventory.

put/api/inventory/v2/inventories/{schemaName}/{id}/status

Request

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

Path parameters

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

The name property of the schema.

idstring uuid required

The unique identifier of an inventory record.

Request body

keystring required

The key identifier

namestring

The display name associated with the key

Example request

{
  "key": "active",
  "name": "Active"
}

Response

OK - Inventory status successfully updated.

Changes

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