---
title: "Get Term Attribute"
method: GET
path: "/api/glossary/v1/terms/attribute-details/{name}"
tags: ["Terms"]
---

# Get Term Attribute

`GET /api/glossary/v1/terms/attribute-details/{name}`

Use this API to retrieve the details of a specific term attribute.

## Path parameters

- `name` string, required

## Response `200`

OK 
Term Attribute response retrieved successfully.

- DataUseGovernanceDataCatalogOneTrustResponseOfListOfAttributeInformation
  - `data` DataUseGovernanceDataCatalogAttributeInformation[]
    - `id` string, uuid — Attribute GUID
    - `name` string, required — Attribute name
    - `nameKey` string — Attribute name key which can be used for translation
    - `description` string — Attribute description
    - `descriptionKey` string — Attribute description key which can be used for translation
    - `fieldName` string, required — Attribute field name which can be used for uniquely identifying an attribute
    - `mappedFieldName` string — Mapped Attribute field name. Should be used for sorting
    - `enabled` boolean, required — Indicator for attribute enabled/disabled
    - `required` boolean — Indicator for mandatory attribute
    - `readOnly` boolean — Indicator for read only attribute
    - `encrypted` boolean — Indicate whether to encrypt the field value or not. Only supported for text, single select and multi select
    - `allowOther` boolean — Indicator for allowing user defined options for attribute
    - `baseAttribute` boolean — Indicate if attribute is part of extendable entity and which cannot be modified
    - `responseType` 'Text' | 'SingleSelect' | 'MultiSelect' | 'Date' | 'Formula' | 'Score' | 'Level' | 'Range' — Response type for attribute
    - `formula` string — Formula for attribute
    - `optionType` 'None' | 'Static' | 'Dynamic' — Attribute Options value source type
    - `optionAllowed` boolean — Indicate if attribute can have static options or not
    - `schemaId` string, uuid — Attribute Schema GUID
    - `schemaName` string — Attribute Schema Name
    - `options` DataUseGovernanceDataCatalogAttributeOptionInformation[] — Option's for given attribute based on response type
      - `id` string, uuid — Option GUID
      - `option` string, required — Option name
      - `optionKey` string — Option Key which can be used for translation
      - `colorCode` string — Color code for the option
      - `sequence` integer — Option sequence for ordering
      - `enabled` boolean — Indicates if the option is enabled or disabled
      - `metadata` DataUseGovernanceDataCatalogAttributeOptionMetadata
        - `hint` string — Hint
        - `hintKey` string — Hint key which can be used for translation
    - `referenceCategories` DataUseGovernanceDataCatalogCategoryInformation[] — Categories for given attribute
      - `id` string, uuid — Category unique identifier
      - `name` string — Category name
      - `nameKey` string — Category nameKey for localization support
    - `responseMaxLength` integer — Response max length
    - `responseSubType` 'STANDARD' | 'FORMULA' | 'MATRIX' — Response sub type
    - `associatedAttributeInformation` DataUseGovernanceDataCatalogAssociatedAttributeInformation[] — Associated attribute information
      - `id` string, uuid, required — Associated Attribute GUID
      - `name` string — Name
      - `nameKey` string — Name key
      - `description` string — Description
      - `descriptionKey` string — Description Key
      - `schemaId` string, uuid — Attribute Schema GUID
      - `schemaName` string — Attribute Schema Name
      - `fieldName` string, required — Attribute field name
      - `mappedFieldName` string — Mapped Attribute field name. Should be used for sorting
      - `enabled` boolean, required — Indicator for attribute enabled/disabled
      - `responseType` 'Text' | 'SingleSelect' | 'MultiSelect' | 'Date' | 'DateTime' | 'NumericalText' | 'NumericalSingleSelect' | 'RadioButton' | 'TextArea' | 'Formula' | 'Level' | 'Range' | 'Score' | 'System', required — Response Type
      - `responseSubType` 'Standard' | 'Formula' | 'Matrix' | 'RollUp' — Response sub type
      - `formula` string — Formula for attribute
      - `options` DataUseGovernanceDataCatalogAttributeOptionInformation[] — Attribute options
        - `id` string, uuid — Option GUID
        - `option` string, required — Option name
        - `optionKey` string — Option Key which can be used for translation
        - `colorCode` string — Color code for the option
        - `sequence` integer — Option sequence for ordering
        - `enabled` boolean — Indicates if the option is enabled or disabled
        - `metadata` DataUseGovernanceDataCatalogAttributeOptionMetadata
          - `hint` string — Hint
          - `hintKey` string — Hint key which can be used for translation
    - `multiSelectMaxOptionValues` integer — MultiSelect max option values
    - `hidden` boolean — Hidden
    - `optionUrl` string — OptionUrl
    - `intakeQuestion` DataUseGovernanceDataCatalogIntakeQuestion
      - `nameKey` string
      - `name` string
      - `descriptionKey` string
      - `description` string
    - `deleteMarker` 'MARKED_FOR_DELETE' | 'DELETING' | 'DELETED' — Indicate the status of an attribute's deletion process
    - `optionMetadata` DataUseGovernanceDataCatalogAttributeOptionMetadataInformation
      - `entityTypeName` string — Option Source Entity Type
      - `basicServiceContextPath` string — Basic Url for the Option source Service
      - `optionUrl` string — Api URL for the Drop Down Api
      - `viewType` string — This will help to identify the view type of list
    - `validationRuleId` string — Validation Rule configured for Attribute (e.g., email, URL)
    - `associatedAttributeFieldName` string
  - `meta` DataUseGovernanceDataCatalogOneTrustMetadata
    - `page` DataUseGovernanceDataCatalogOneTrustPage
      - `first` boolean — This parameter indicates whether the current page is the first page of the list.
      - `last` boolean — This parameter indicates whether the current page is the last page of the list.
      - `number` integer — The page number of the results.
      - `size` integer — The number of results per page.
      - `totalElements` integer — The total number of results in the list.
      - `totalPages` integer — The total number of pages in the list.
      - `sort` DataUseGovernanceDataCatalogOneTrustSort[] — The sort criteria that dictates the order of the results.
        - `direction` 'ASC' | 'DESC' — The order (ASC|DESC) by which results are sorted.
        - `property` string — The criteria by which results are sorted.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `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.net/onetrust/apis/platform-access-management.md) · [All operations](https://skmtc.net/onetrust/apis/platform-access-management/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/onetrust/platform-access-management/versions/21de3aa0b170/schema)