---
title: "Get Inventory Schema Details"
method: GET
path: "/api/inventory/v2/schemas/{schemaName}/attributes/{fieldName}"
tags: ["Inventory Schema"]
---

# Get Inventory Schema Details

`GET /api/inventory/v2/schemas/{schemaName}/attributes/{fieldName}`

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

## Path parameters

- `schemaName` 'processing-activities' | 'vendors' | 'assets' | 'entities', required
- `fieldName` string, required

## Query parameters

- `showAll` boolean
- `optionsSize` integer

## Response `200`

OK

- AttributeDetailResponse
  - `id` string, uuid
  - `name` string
  - `fieldName` string
  - `nameKey` string — Key used for name translation
  - `description` string — Description of the attribute
  - `descriptionKey` string — Key used for description translation
  - `required` boolean — 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
  - `readOnly` boolean — Flag indicating if the attribute is read-only
  - `seeded` boolean — Flag indicating if the attribute is seeded (system-provided)
  - `hiddenAtInventory` boolean — Flag indicating if the attribute is hidden at inventory detail view
  - `trackedAtRelatedInventoryType` string — Related inventory type where this attribute is tracked
  - `source` 'System' | 'Custom' | 'Vendorpedia' — Source of the attribute
  - `dataSource` AttributeDataSourceDto
    - `Attribute Data Source Key` string, required
    - `Attribute Data Source Name` string, required
    - `Attribute Data Source Name Key for translation` string, required
  - `formula` string — Formula expression for formula-type attributes
  - `schemaName` string — Name of the schema this attribute belongs to
  - `hidden` boolean — Flag indicating if the attribute is hidden
  - `allowLabels` boolean — Flag indicating if the attribute allows labels
  - `intakeQuestionKey` string — Key for the intake question
  - `intakeQuestion` IntakeQuestion
    - `nameKey` string — The question name key for schema.
    - `name` string — The question name for schema.
    - `descriptionKey` string — The question description key for schema.
    - `description` string — The question description for schema.
  - `validationRuleId` string — ID of the validation rule applied to this attribute
  - `assignments` AbacBasicAssignmentInfo[] — Assignments for the Attribute
    - `assignmentId` string, uuid — GUID of the linked assignment
    - `assignmentName` string — Name of the linked assignment
    - `policyStatus` 'INACTIVE' | 'ACTIVE' | 'PROCESSING' | 'FAILED' — Policy status of the linked assignment
  - `allowOther` boolean
  - `values` AttributeValueResponse[]
    - `id` string — Unique identifier of the attribute value
    - `value` string — Value of the attribute option
    - `valueKey` string — Key used for value translation
    - `hint` string — Hint text for the attribute value
    - `hintKey` string — Key used for hint translation
    - `status` 'enabled' | 'disabled' — Status of the attribute value
    - `seeded` boolean — Flag indicating if the attribute value is seeded (system-provided)
    - `sequence` integer — Sequence number for ordering
    - `colorCode` string — Color code for visual representation
    - `selectionValue` string — Selection value for numerical attributes
  - `autoUpdate` boolean
  - `attributeLaws` KeyNameDto[]
    - `key` string, required — The key identifier
    - `name` string — The display name associated with the key
  - `responseSubType` 'Standard' | 'Formula' | 'Matrix' | 'RollUp' — Sub-type of the response
  - `associatedAttributes` AssociatedAttributeResponse[] — List of associated attributes
    - `id` string, uuid
    - `name` string
    - `fieldName` string
    - `nameKey` string
    - `description` string
    - `descriptionKey` string
    - `status` string
    - `responseType` string
    - `responseSubType` 'Standard' | 'Formula' | 'Matrix' | 'RollUp'
    - `formula` string
    - `schemaName` string
    - `hidden` boolean, required
    - `readOnly` boolean
    - `Attribute options` AttributeValueResponse[]
      - `id` string — Unique identifier of the attribute value
      - `value` string — Value of the attribute option
      - `valueKey` string — Key used for value translation
      - `hint` string — Hint text for the attribute value
      - `hintKey` string — Key used for hint translation
      - `status` 'enabled' | 'disabled' — Status of the attribute value
      - `seeded` boolean — Flag indicating if the attribute value is seeded (system-provided)
      - `sequence` integer — Sequence number for ordering
      - `colorCode` string — Color code for visual representation
      - `selectionValue` string — Selection value for numerical attributes

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `429` — Too Many Requests. For more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).
- `500` — Internal Server Error

---

[API](https://skmtc.dev/onetrust/apis/platform-access-management.md) · [All operations](https://skmtc.dev/onetrust/apis/platform-access-management/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/onetrust/platform-access-management/revisions/21de3aa0b170/schema)