update_glossary_term¶

CatalogApi.update_glossary_term(glossary_id, term_id, role_id, term_update_input, content_type=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Update a glossary term

Updates a glossary term’s name or definition. A new name must still be unique within the glossary. Requires editor access or higher.

Parameters:

glossary_id (str) – Identifier of the glossary the term belongs to. (required)
term_id (str) – Identifier of the term to update. (required)
role_id (str) – User role id (required)
term_update_input (TermUpdateInput) – (required)
content_type (str) – Must be application/json.
_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:

UpdateGlossaryTermResponse

Returns:

Returns the result object.

Request and Response Examples¶

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

Request¶

Change the definition

{
  "Definition": "A customer with at least one paid order in the trailing 90 days."
}

Rename the term

{
  "TermName": "ActiveCustomer90d"
}

Replace the linked assets

{
  "DataReferences": [
    {
      "AssetType": "dataset",
      "Assets": [
        {
          "DatasourceId": "ds-8f2e1a2b",
          "AssetId": "asset-4c7a8f2e",
          "AssetName": "customers",
          "Columns": [
            "customer_id",
            "status"
          ]
        }
      ]
    }
  ]
}

Success (HTTP 200)¶

Successfully updated glossary term details

Request / response example

{
  "Message": "Glossary term updated successfully"
}

Errors¶

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

HTTP 400

Missing required request parameters

TermId does not exist

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

TermName supplied but blank

{
  "Message": "GE-1034 - TermName cannot be empty"
}

AssetType outside the supported set

{
  "Message": "IPV-1041 - Invalid parameter - AssetType, allowed values/keys are dict_keys(['dataset'])"
}

HTTP 500

Something went wrong at backend

Request / response example

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