Glossary

Get Glossary Object

get

Get a glossary object by ID and AssetType

Query parameters

idintegerrequired

typestring · enumrequired

Options: glossary, category, term

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://connect.decube.io/api/v1/data/catalog/glossary?id=1&type=glossary'

200

422

200

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

Successful Response

Create Glossary Object

post

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

Body

any ofoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://connect.decube.io/api/v1/data/catalog/glossary' \
  --header 'Content-Type: application/json' \
  --data '{
    "type": "glossary",
    "name": "text",
    "description": "text",
    "data_owner": "text",
    "business_owners": [
      "text"
    ]
  }'

200

422

200

{
  "id": 1,
  "type": "glossary"
}

Successful Response

Delete Glossary Object

delete

Deletes an existing glossary object.

Query parameters

idintegerrequired

Id of glossary object

typestring · enumrequired

Options: glossary, category, term

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://connect.decube.io/api/v1/data/catalog/glossary?id=1&type=glossary'

200

422

200

No body

Successful Response

Modify Glossary Object

patch

Modifies an existing glossary object.

Body

any ofoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://connect.decube.io/api/v1/data/catalog/glossary' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": 1,
    "type": "glossary",
    "name": "text",
    "description": "text",
    "data_owner": "text",
    "business_owners": [
      "text"
    ]
  }'

200

422

200

No body

Successful Response

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_idintegeroptional

ID of the parent object

parent_typestring · enumoptional

Type of the parent object

Options: glossary, category

typestring · enumoptional

Filters the result to only contain glossary objects of this type

Options: glossary, category, term

page_sizeinteger · min: 1 · max: 100 · default: 10optional

pageinteger · min: 1 · default: 1optional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://connect.decube.io/api/v1/data/catalog/glossary/list'

200

422

200

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

Successful Response

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

typestring · enumoptional

Filters the result to only contain glossary objects of this type

Options: glossary, category, term

namestringoptional

Search for glossary object based on the name. Case sensitive

is_fuzzyboolean · default: falseoptional

Fuzzy search with name argument

max_resultsinteger · max: 100 · default: 10optional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://connect.decube.io/api/v1/data/catalog/glossary/search'

200

422

200

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

Successful Response

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

idintegerrequired

typestring · enumrequired

Options: term

documentationobjectrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://connect.decube.io/api/v1/data/catalog/glossary/documentation' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": 1,
    "type": "term",
    "documentation": {}
  }'

200

422

200

No body

Successful Response

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

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://connect.decube.io/api/v1/data/catalog/glossary/documentation?term_id=1'

200

422

200

No body

Successful Response