Glossaries
Get Glossary
Use this API to retrieve the details for the specified business glossary. The response will include details such as the glossary ID, description, and created date.
get/api/glossary/v1/glossaries/name/{glossaryName}
Path parameters
glossaryNamestring required
The name to get the corresponding glossary details.
Response
OK Glossary Details retrieved successfully.
Example response
{
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Sample Name",
"nameKey": "SAMPLE_NAME_KEY",
"numericId": 12345,
"description": "This glossary contains financial terms",
"descriptionKey": "FINANCIAL_GLOSSARY_DESC",
"businessOwner": [
"123e4567-e89b-12d3-a456-426614174001"
],
"dataSteward": [
"123e4567-e89b-12d3-a456-426614174001"
],
"subjectMatterExpert": [
"123e4567-e89b-12d3-a456-426614174001"
],
"createdDate": "2023-01-01T00:00:00Z",
"lastUpdatedDate": "2023-01-02T00:00:00Z",
"createdBy": "123e4567-e89b-12d3-a456-426614174003",
"lastUpdatedBy": "123e4567-e89b-12d3-a456-426614174004",
"terms": [
{
"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"
}
]
}
]
}
}