ONonetrust
Inventory Schema

Manage Attribute Options

Use this API to manage attribute options in the assessment questions and inventories.

🗒 Things to Know

  • This API supports deactivating/activating attribute options.
  • This API can also be used for editing option names.
put/api/inventory/v2/schemas/attributes/{attributeId}/values/{valueId}

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/api/inventory/v2/schemas/attributes/{attributeId}/values/{valueId}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: INVENTORY, INVENTORY_WRITE

Path parameters

attributeIdstring uuid required

ID of an attribute. The value is obtained using Get Inventory Schema API.

valueIdstring uuid required

ID of the attribute value to update

Request body

AttributeIdstring uuid required
Valuestring required

Value of the attribute option

Status'enabled' | 'disabled'

Status of the attribute value

hintstring

Hint text for the attribute value

colorCodestring

Color code for visual representation

selectionValuestring

Selection value for numerical attributes

Example request

{
  "AttributeId": "43fd3a8d-3f6b-464e-bf43-3f0c6c592442",
  "Value": "Option 1",
  "Status": "enabled",
  "hint": "Select this option if...",
  "colorCode": "#FF5733"
}

Response

OK

idstring

Unique identifier of the attribute value

valuestring

Value of the attribute option

valueKeystring

Key used for value translation

hintstring

Hint text for the attribute value

hintKeystring

Key used for hint translation

status'enabled' | 'disabled'

Status of the attribute value

seededboolean

Flag indicating if the attribute value is seeded (system-provided)

sequenceinteger

Sequence number for ordering

colorCodestring

Color code for visual representation

selectionValuestring

Selection value for numerical attributes

Example response

{
  "id": "91e37a36-ca61-499b-b3c3-7d556aef5cde",
  "value": "Option 1",
  "valueKey": "VendorsOption1",
  "hint": "Select this option if...",
  "hintKey": "VendorsOption1Hint",
  "status": "enabled",
  "seeded": true,
  "sequence": 1,
  "colorCode": "#FF5733"
}

Changes

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