Terms
Get List of Terms
Use this API to retrieve a list of all terms or search for a specific term. The response will include details for each term along with the corresponding term ID, name, and glossary to which the term belongs.
get/api/glossary/v1/terms
Query parameters
namestring
The name of the term that needs to be searched for within the list of terms.
pageinteger
Results page to be retrieved (0..N).
sizeinteger
Number of records per page.
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"
},
"numericId": 12345,
"example": "Example usage of this term in a sentence",
"businessOwner": [
"32d50775-17c3-44f0-88da-575b8a10c9fb"
],
"technicalOwner": [
"123e4567-e89b-12d3-a456-426614174001"
],
"dataSteward": [
"123e4567-e89b-12d3-a456-426614174001"
],
"notes": "Additional information about term usage",
"source": "Internal Documentation",
"createdDate": "2023-01-01T00:00:00Z",
"lastUpdatedDate": "2023-01-02T00:00:00Z",
"createdBy": "123e4567-e89b-12d3-a456-426614174003",
"lastUpdatedBy": "123e4567-e89b-12d3-a456-426614174004",
"status": "ACTIVE",
"associatedTags": [
"123e4567-e89b-12d3-a456-426614174001"
],
"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"
}
]
}
]
}