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 Glossary Object

get

Get a glossary object by ID and AssetType

Query parameters

idintegerRequired

typestring · enumRequiredPossible values:

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/catalog/glossary

HTTPcURLJavaScriptPython

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": {}
}

Create Glossary Object

post

Creates a glossary object and return the ID of the newly created object

Body

application/json

or

or

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/catalog/glossary

HTTPcURLJavaScriptPython

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"
}

Delete Glossary Object

delete

Deletes an existing glossary object.

Query parameters

idintegerRequired

Id of glossary object

typestring · enumRequiredPossible values:

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

delete

/catalog/glossary

HTTPcURLJavaScriptPython

DELETE /api/v1/data/catalog/glossary?id=1&type=glossary HTTP/1.1
Host: connect.<REGION>.decube.io
Accept: */*

No content

Modify Glossary Object

patch

Modifies an existing glossary object.

Body

application/json

or

or

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

patch

/catalog/glossary

HTTPcURLJavaScriptPython

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

get

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.

Query parameters

parent_idany ofOptional

ID of the parent object

integerOptional

or

nullOptional

parent_typeany ofOptional

Type of the parent object

string · enumOptionalPossible values:

or

nullOptional

typeany ofOptional

Filters the result to only contain glossary objects of this type

string · enumOptionalPossible values:

or

nullOptional

page_sizeinteger · min: 1 · max: 100OptionalDefault: 10

pageinteger · min: 1OptionalDefault: 1

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/catalog/glossary/list

HTTPcURLJavaScriptPython

GET /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

get

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.

Query parameters

typeany ofOptional

Filters the result to only contain glossary objects of this type

string · enumOptionalPossible values:

or

nullOptional

nameany ofOptional

Search for glossary object based on the name. Case sensitive

stringOptional

or

nullOptional

is_fuzzybooleanOptional

Fuzzy search with name argument

Default: false

max_resultsinteger · max: 100OptionalDefault: 10

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/catalog/glossary/search

HTTPcURLJavaScriptPython

GET /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": {}
  }
]

Attach Documentation To Term

post

Attaches documentation to a term. If an existing documentation is already attached to a term, it will be replaced.

Body

application/json

idintegerRequired

typeconst: termRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

post

/catalog/glossary/documentation

HTTPcURLJavaScriptPython

POST /api/v1/data/catalog/glossary/documentation HTTP/1.1
Host: connect.<REGION>.decube.io
Content-Type: application/json
Accept: */*
Content-Length: 150

{
  "id": 1,
  "type": "text",
  "documentation": {
    "type": "text",
    "content": [
      {
        "type": "text",
        "content": [
          {
            "type": "text",
            "text": "text",
            "marks": [
              {
                "type": "bold"
              }
            ]
          }
        ]
      }
    ]
  }
}

No content

Delete Documentation To Term

delete

Deletes documentation of a term. Deletes the documentation attached to a term.

Query parameters

term_idintegerRequired

The ID of the Term.

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

delete

/catalog/glossary/documentation

HTTPcURLJavaScriptPython

DELETE /api/v1/data/catalog/glossary/documentation?term_id=1 HTTP/1.1
Host: connect.<REGION>.decube.io
Accept: */*

No content