Glossary
The Glossary API allows you to manage business terms, categories, and their definitions within your Decube organization. Use these endpoints to create, update, search, and organize glossary terms that provide consistent business context for your data assets.
Use the Glossary API to:
Create and manage glossary terms and categories
Search and list glossary objects with filtering
Attach and manage documentation for terms
Build automated glossary synchronization workflows
Maintain consistent business terminology across systems
Get a glossary object by ID and AssetType
GET /api/v1/data/catalog/glossary?id=1&type=glossary HTTP/1.1
Host: connect.<REGION>.decube.io
Accept: */*
{
"asset": {
"type": "text",
"name": "text",
"id": 1,
"subtype": "bigquery",
"qual_id": "text",
"icon": "text"
},
"parents": [
{
"type": "text",
"name": "text",
"id": 1,
"subtype": "bigquery",
"qual_id": "text",
"icon": "text"
}
],
"assets": [
{
"type": "text",
"name": "text",
"id": 1,
"subtype": "bigquery",
"qual_id": "text",
"icon": "text"
}
],
"attrs": {}
}Creates a glossary object and return the ID of the newly created object
POST /api/v1/data/catalog/glossary HTTP/1.1
Host: connect.<REGION>.decube.io
Content-Type: application/json
Accept: */*
Content-Length: 97
{
"type": "text",
"name": "text",
"description": "text",
"data_owner": "text",
"business_owners": [
"text"
]
}{
"id": 1,
"type": "glossary"
}Deletes an existing glossary object.
Id of glossary object
DELETE /api/v1/data/catalog/glossary?id=1&type=glossary HTTP/1.1
Host: connect.<REGION>.decube.io
Accept: */*
No content
Modifies an existing glossary object.
PATCH /api/v1/data/catalog/glossary HTTP/1.1
Host: connect.<REGION>.decube.io
Content-Type: application/json
Accept: */*
Content-Length: 104
{
"id": 1,
"type": "text",
"name": "text",
"description": "text",
"data_owner": "text",
"business_owners": [
"text"
]
}No content
List glossary objects. If parent_id and parent_type is specified, will return all glossary objects under the parent Glossary object. If type is defined, will return all glossary objects of that type only. page_size limit is 100.
ID of the parent object
Type of the parent object
Filters the result to only contain glossary objects of this type
101GET /api/v1/data/catalog/glossary/list HTTP/1.1
Host: connect.<REGION>.decube.io
Accept: */*
[
{
"asset": {
"type": "text",
"name": "text",
"id": 1,
"subtype": "bigquery",
"qual_id": "text",
"icon": "text"
},
"parents": [
{
"type": "text",
"name": "text",
"id": 1,
"subtype": "bigquery",
"qual_id": "text",
"icon": "text"
}
],
"assets": [
{
"type": "text",
"name": "text",
"id": 1,
"subtype": "bigquery",
"qual_id": "text",
"icon": "text"
}
],
"attrs": {}
}
]Search glossary objects. If name is specified will return all glossary objects with that name. is_fuzzy flag turns on fuzzy searching that allows non-exact matching. max_results limit is 100.
Filters the result to only contain glossary objects of this type
Search for glossary object based on the name. Case sensitive
Fuzzy search with name argument
false10GET /api/v1/data/catalog/glossary/search HTTP/1.1
Host: connect.<REGION>.decube.io
Accept: */*
[
{
"asset": {
"type": "text",
"name": "text",
"id": 1,
"subtype": "bigquery",
"qual_id": "text",
"icon": "text"
},
"parents": [
{
"type": "text",
"name": "text",
"id": 1,
"subtype": "bigquery",
"qual_id": "text",
"icon": "text"
}
],
"assets": [
{
"type": "text",
"name": "text",
"id": 1,
"subtype": "bigquery",
"qual_id": "text",
"icon": "text"
}
],
"attrs": {}
}
]Attaches documentation to a term. If an existing documentation is already attached to a term, it will be replaced.
POST /api/v1/data/catalog/glossary/documentation HTTP/1.1
Host: connect.<REGION>.decube.io
Content-Type: application/json
Accept: */*
Content-Length: 41
{
"id": 1,
"type": "text",
"documentation": {}
}No content
Deletes documentation of a term. Deletes the documentation attached to a term.
The ID of the Term.
DELETE /api/v1/data/catalog/glossary/documentation?term_id=1 HTTP/1.1
Host: connect.<REGION>.decube.io
Accept: */*
No content
Last updated