Terms
Get Term
Use this API to retrieve the details for the specified term. The response will return the term ID, description, and type along with its associated tags.
get/api/glossary/v1/terms/name/{termName}
Path parameters
termNamestring required
The name to get the term details along with the tag details. For example, including the value for the name URL, matching term details with the associated tags will be retrieved.
Response
OK Term Details response retrieved successfully.
Example response
{
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Sample Name",
"nameKey": "SAMPLE_NAME_KEY",
"type": "Business",
"typeKey": "BUSINESS_TYPE",
"shortDescription": "A short explanation of what this term means",
"glossary": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"value": "Sample Value",
"key": "SAMPLE_KEY"
},
"tags": [
{
"id": "123e4567-e89b-12d3-a456-426614174001",
"tagId": 45,
"name": "Resume",
"description": "This tag is used for any information related to Resume",
"type": "CLASSIFICATION",
"createdBy": "897e4567-e89b-12d3-2345-426614174789",
"createdDate": "2023-01-01T00:00:00Z",
"updatedBy": "897e4567-e89b-12d3-2345-426614174789",
"updatedDate": "2023-01-02T00:00:00Z",
"athenaId": "754e4567-de34-12d3-a456-ddf414174777"
}
]
}
}