get_glossary_term

CatalogApi.get_glossary_term(glossary_id, term_id, role_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Get glossary term details

Returns a single glossary term, including the data assets linked to it. Requires read-only access or higher on the glossary. Links to assets that no longer exist are removed from the term as part of this call.

Parameters:

  • glossary_id (str) – Identifier of the glossary the term belongs to. (required)

  • term_id (str) – Identifier of the term. (required)

  • role_id (str) – User role id (required)

  • _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:

TermDetails

Returns:

Returns the result object.

Request and Response Examples

HTTP: GET /glossaries/{glossary_id}/terms/{term_id}

Success (HTTP 200)

Successfully returns glossary term details

Request / response example

{
  "TermId": "a5c8e2f1-7b34-4d69-8e0a-2f6b9c1d4e73",
  "TermName": "ActiveCustomer",
  "GlossaryId": "3d9a7c14-6b2e-4f80-91ac-5e7d8b3f2a61",
  "GlossaryName": "CustomerMetrics",
  "Definition": "A customer with at least one order in the trailing 90 days.",
  "DataReferences": [
    {
      "AssetType": "dataset",
      "Assets": [
        {
          "DatasourceId": "ds-8f2e1a2b",
          "AssetId": "asset-4c7a8f2e",
          "AssetName": "customers",
          "Columns": [
            "customer_id",
            "status"
          ]
        }
      ]
    }
  ],
  "CreatedBy": "jdoe",
  "CreatedTime": "2026-07-16 11:00:00",
  "LastModifiedBy": "jdoe",
  "LastModifiedTime": "2026-08-11 08:15:30"
}

Errors

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

HTTP 400

Invalid input parameters

TermId does not exist

{
  "Message": "IPV-1002 - Invalid TermId - a5c8e2f1-7b34-4d69-8e0a-2f6b9c1d4e73, resource not found."
}

GlossaryId does not exist

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

HTTP 500

Something went wrong at backend

Request / response example

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