Catalog

APIs related to Catalog functionality

📄️ List accessible glossaries

Returns the glossaries the caller has access to, with their access level. Terms are omitted from the listing - use the get-by-id operation to retrieve them. Read next_available in the response to know whether another page exists.

📄️ Create a glossary or start bulk upload

Without action, creates a single glossary and makes the caller its owner; a request body is required. With action=get-presigned-url, returns an upload URL for a bulk-upload JSON file and reads no body. With action=upload-glossaries, starts background creation from the uploaded file and requires a body containing S3Key.

📄️ 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.

📄️ 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.

📄️ 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.

📄️ List all the terms in a glossary

Returns the terms defined in a glossary. Requires read-only access or higher on the glossary. Read next_available in the response to know whether another page exists.

📄️ Create a glossary term

Creates a term in the glossary. The term name must be unique within the glossary and the definition cannot be empty. Requires editor access or higher.

📄️ 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.

📄️ 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.

📄️ Delete a glossary term

Deletes a glossary term and unlinks it from any data assets that referenced it. Requires editor access or higher - unlike deleting a whole glossary, which requires owner access.

📄️ Search catalog assets

Searches across catalog data sources and returns the assets associated with each. Despite being a POST, this operation takes no request body: every input is a query parameter, and any body sent is ignored.

📄️ Generate user custom actions for catalog assets

Generates ready-to-use connection templates and instructions for a set of catalog assets, covering the SQL playground and the supported analytics tools, plus any caveats that apply to the specific assets chosen.

📄️ Get the entity relationship map for an asset

Returns the dependency graph of a catalog asset: the asset itself plus the assets it depends on and that depend on it, as a flat node list with edges carried inside each node.