get_glossary¶

CatalogApi.get_glossary(glossary_id, role_id, projection_expression=None, action=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Get glossary details or linked assets

Returns the glossary with its access level and the id and name of each of its terms. Requires read-only access or higher. With action=get-linked-assets, returns the data assets linked to each term instead of the glossary itself.

Parameters:

glossary_id (str) – Identifier of the glossary. (required)
role_id (str) – User role id (required)
projection_expression (str) – Comma-separated list of fields to return; all other fields are omitted. Ignored when action=get-linked-assets.
action (str) – Omit to return the glossary. Use get-linked-assets to return the assets linked to its terms.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

GetGlossary200Response

Returns:

Returns the result object.

Request and Response Examples¶

HTTP: GET /glossaries/{glossary_id}

Success (HTTP 200)¶

Successfully returns glossary details or linked assets

action=get-linked-assets - map of term name to linked assets

{
  "ActiveCustomer": [
    {
      "AssetType": "dataset",
      "AssetName": "customers",
      "AssetId": "asset-4c7a8f2e",
      "Columns": [
        "customer_id",
        "status"
      ]
    }
  ]
}

Default response

{
  "GlossaryId": "3d9a7c14-6b2e-4f80-91ac-5e7d8b3f2a61",
  "GlossaryName": "CustomerMetrics",
  "GlossaryStatus": "completed",
  "Description": "Business terms for customer analytics",
  "Terms": [
    {
      "TermId": "a5c8e2f1-7b34-4d69-8e0a-2f6b9c1d4e73",
      "TermName": "ActiveCustomer"
    }
  ],
  "CreatedBy": "jdoe",
  "CreatedTime": "2026-07-15 09:30:00",
  "LastModifiedBy": "jdoe",
  "LastModifiedTime": "2026-08-10 14:22:41",
  "AccessType": "owner"
}

Errors¶

Documented error codes: IPV-1002, AUTH-1002, GE-1020.

HTTP 400

Invalid input parameters

GlossaryId does not exist

{
  "Message": "IPV-1002 - Invalid GlossaryId - 3d9a7c14-6b2e-4f80-91ac-5e7d8b3f2a61, resource not found."
}

Caller has no access on the glossary

{
  "Message": "AUTH-1002 - User action is not permitted"
}

HTTP 500

Something went wrong at backend

Request / response example

{
  "Message": "GE-1020 - Unable to update Glossary table, please retry or contact administrator"
}