delete_glossary

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

Delete a glossary

Deletes the glossary and every term inside it, and unlinks those terms from any data assets that referenced them. Requires owner access. This cannot be undone.

Parameters:

  • glossary_id (str) – Identifier of the glossary. (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:

DeleteGlossaryResponse

Returns:

Returns the result object.

Request and Response Examples

HTTP: DELETE /glossaries/{glossary_id}

Success (HTTP 200)

Glossary deleted successfully

Request / response example

{
  "Message": "Glossary deleted successfully"
}

Errors

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

HTTP 400

Missing required request parameters

GlossaryId does not exist

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

Caller is not an owner of the glossary

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

HTTP 500

Something went wrong at backend

Request / response example

{
  "Message": "GE-1021 - Unable to delete items in Glossaries table, please check for errors"
}