Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Inventory Schema

Get Inventory Schema Details

Use this API to retrieve the schema details by field name.

get/api/inventory/v2/schemas/{schemaName}/attributes/{fieldName}

Path parameters

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

Type of the inventory or schema. The supporting types are 'processing-activities', 'vendors', 'assets', and 'entities'.

fieldNamestring required

Field name of the attribute to retrieve details for

Query parameters

showAllboolean

Flag to show all attribute values including inactive ones

optionsSizeinteger

Response

OK

idstring uuid
namestring
fieldNamestring
nameKeystring

Key used for name translation

descriptionstring

Description of the attribute

descriptionKeystring

Key used for description translation

requiredboolean

Flag indicating if the attribute is required

status'enabled' | 'disabled'

Status of the attribute

attributeType'none' | 'users' | 'locations' | 'organizations' | 'vendors' | 'assets' | 'entities' | 'processing-activities' | 'statuses'

Type of the attribute

responseType'text' | 'date' | 'single-select' | 'multi-select' | 'numerical-text' | 'numerical-single-select' | 'score' | 'formula'

Response type of the attribute

readOnlyboolean

Flag indicating if the attribute is read-only

seededboolean

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

hiddenAtInventoryboolean

Flag indicating if the attribute is hidden at inventory detail view

trackedAtRelatedInventoryTypestring

Related inventory type where this attribute is tracked

source'System' | 'Custom' | 'Vendorpedia'

Source of the attribute

formulastring

Formula expression for formula-type attributes

schemaNamestring

Name of the schema this attribute belongs to

hiddenboolean

Flag indicating if the attribute is hidden

allowLabelsboolean

Flag indicating if the attribute allows labels

intakeQuestionKeystring

Key for the intake question

validationRuleIdstring

ID of the validation rule applied to this attribute

allowOtherboolean
autoUpdateboolean
responseSubType'Standard' | 'Formula' | 'Matrix' | 'RollUp'

Sub-type of the response

Example response

{
  "nameKey": "VendorsName",
  "description": "Name of the vendor",
  "descriptionKey": "VendorsNameDesc",
  "required": true,
  "status": "enabled",
  "attributeType": "none",
  "responseType": "single-select",
  "seeded": true,
  "trackedAtRelatedInventoryType": "vendors",
  "source": "System",
  "formula": "sum(Assets:customField1044,Entities:customField1001)",
  "schemaName": "Vendors",
  "intakeQuestionKey": "VendorsIntakeQuestion1",
  "validationRuleId": "f17a3b03-62da-4448-b3bb-e56d4a2291c2",
  "assignments": [
    {
      "assignmentId": "550e8400-e29b-41d4-a716-446655440000",
      "assignmentName": "Assignment1",
      "policyStatus": "ACTIVE"
    }
  ],
  "values": [
    {
      "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"
    }
  ],
  "attributeLaws": [
    {
      "key": "active",
      "name": "Active"
    }
  ],
  "responseSubType": "Standard",
  "associatedAttributes": [
    {
      "Attribute options": [
        {
          "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"
        }
      ]
    }
  ]
}