update_glossary

CatalogApi.update_glossary(glossary_id, role_id, glossary_update_input, content_type=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

Update glossary description

Updates the glossary description. The glossary name cannot be changed, and the body is rejected if it contains any field other than Description. Requires editor access or higher.

Parameters:

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

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

  • glossary_update_input (GlossaryUpdateInput) – (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:

UpdateGlossaryResponse

Returns:

Returns the result object.

Request and Response Examples

HTTP: PUT /glossaries/{glossary_id}

Request

Request / response example

{
  "Description": "Business terms for customer analytics and retention"
}

Success (HTTP 200)

Successfully updated glossary details

Request / response example

{
  "Message": "Glossary updated successfully"
}

Errors

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

HTTP 400

Missing required request parameters

Description is required

{
  "Message": "IPV-1001 - Parameter Description is a required value."
}

Field not accepted on update

{
  "Message": "IPV-1040 - Invalid elements found in input fields - 'GlossaryName'"
}

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 Glossary table, please retry or contact administrator"
}