Glossary

Get Glossary Object

get

Get a glossary object by ID and AssetType

Query parameters

idintegerrequired

typestring · enumrequiredAvailable options:

Responses

application/json

objectoptional

application/json

get

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

any ofoptional

Responses

application/json

objectoptional

application/json

post

HTTPcURLJavaScriptPython

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

{
  "type": "glossary",
  "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 · enumrequiredAvailable options:

Responses

application/json

anyoptional

application/json

delete

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

any ofoptional

Responses

application/json

anyoptional

application/json

patch

HTTPcURLJavaScriptPython

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

{
  "id": 1,
  "type": "glossary",
  "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_idintegeroptional

ID of the parent object

parent_typestring · enumoptional

Type of the parent object

Available options:

typestring · enumoptional

Filters the result to only contain glossary objects of this type

Available options:

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

pageinteger · min: 1optionalDefault: 1

Responses

application/json

object[]optional

application/json

get

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

typestring · enumoptional

Filters the result to only contain glossary objects of this type

Available options:

namestringoptional

Search for glossary object based on the name. Case sensitive

is_fuzzybooleanoptional

Fuzzy search with name argument

Default: false

max_resultsinteger · max: 100optionalDefault: 10

Responses

application/json

object[]optional

application/json

get

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

idintegerrequired

typestring · enumrequiredAvailable options:

documentationobjectrequired

Responses

application/json

anyoptional

application/json

post

HTTPcURLJavaScriptPython

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

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

application/json

anyoptional

application/json

delete

HTTPcURLJavaScriptPython

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

No Content