Terms
Get Term Attribute
Use this API to retrieve the details of a specific term attribute.
get/api/glossary/v1/terms/attribute-details/{name}
Path parameters
namestring required
The name of attribute to get the term attribute details. For example, including the value for the attribute's name-Notes, matching term attribute will be retrieved.
Response
OK Term Attribute response retrieved successfully.
Example response
{
"data": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Type of the Record",
"nameKey": "IM.Name",
"description": "Gather Type for the record - provide some value related to nature of record",
"descriptionKey": "IM.Name.Description",
"fieldName": "nameOfRecord",
"mappedFieldName": "name",
"enabled": true,
"responseType": "Text",
"formula": "Default:Field4 + Default:Field3 + 100 + avg(CrossSchema:Field4 + Default:Field3)",
"optionType": "None",
"schemaId": "550e8400-e29b-41d4-a716-446655440000",
"schemaName": "vendors",
"options": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"option": "TypeA",
"optionKey": "IM.TypeA",
"colorCode": "#FF5733",
"sequence": 1,
"enabled": true
}
],
"referenceCategories": [
{
"name": "Financial Category",
"nameKey": "IM.FinancialCategoryName"
}
],
"responseMaxLength": 4000,
"responseSubType": "STANDARD",
"associatedAttributeInformation": [
{
"name": "Count of members",
"nameKey": "IM.CountOfMembersName",
"description": "Provide details about count associated with this attribute",
"descriptionKey": "IM.CountOfMembersDesc",
"schemaName": "risk",
"fieldName": "countOfMembers",
"mappedFieldName": "count",
"formula": "sum(1, 3)",
"options": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"option": "TypeA",
"optionKey": "IM.TypeA",
"colorCode": "#FF5733",
"sequence": 1,
"enabled": true
}
]
}
],
"multiSelectMaxOptionValues": 10,
"optionUrl": "/api/risk-v2/risk-categories",
"deleteMarker": "MARKED_FOR_DELETE",
"optionMetadata": {
"entityTypeName": "Location",
"basicServiceContextPath": "/api/location",
"optionUrl": "/api/location/ui/v1/entity-types/names/Location/entities/basic-details"
},
"validationRuleId": "email"
}
]
}