Glossary

Get Glossary Object

Get a glossary object by ID and AssetType

get

/catalog/glossary

Query parameters

idIdrequired

typeTyperequired

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,
    "qual_id": "text",
    "icon": "text",
    "subtype": "bigquery"
  },
  "attrs": {},
  "parents": [
    {
      "type": "text",
      "name": "text",
      "id": 1,
      "qual_id": "text",
      "icon": "text",
      "subtype": "bigquery"
    }
  ],
  "assets": [
    {
      "type": "text",
      "name": "text",
      "id": 1,
      "qual_id": "text",
      "icon": "text",
      "subtype": "bigquery"
    }
  ]
}

Successful Response

Create Glossary Object

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

post

/catalog/glossary

Body

Body

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 '{"name":"text","type":"glossary","business_owners":[null]}'

200

422

200

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

Successful Response

Delete Glossary Object

Deletes an existing glossary object.

delete

/catalog/glossary

Query parameters

idIdrequired

Id of glossary object

typeTyperequired

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

Modifies an existing glossary object.

patch

/catalog/glossary

Body

Body

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","business_owners":[null]}'

200

422

200

No body

Successful Response

List Glossary Objects

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.

get

/catalog/glossary/list

Query parameters

parent_idParent Id

ID of the parent object

parent_typeParent Type

Type of the parent object

Options: glossary, category

typeType

Filters the result to only contain glossary objects of this type

Options: glossary, category, term

page_sizePage Size

pagePage

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,
      "qual_id": "text",
      "icon": "text",
      "subtype": "bigquery"
    },
    "attrs": {},
    "parents": [
      {
        "type": "text",
        "name": "text",
        "id": 1,
        "qual_id": "text",
        "icon": "text",
        "subtype": "bigquery"
      }
    ],
    "assets": [
      {
        "type": "text",
        "name": "text",
        "id": 1,
        "qual_id": "text",
        "icon": "text",
        "subtype": "bigquery"
      }
    ]
  }
]

Successful Response

Search Glossary Objects

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.

get

/catalog/glossary/search

Query parameters

typeType

Filters the result to only contain glossary objects of this type

Options: glossary, category, term

nameName

Search for glossary object based on the name. Case sensitive

is_fuzzyIs Fuzzy

Fuzzy search with name argument

max_resultsMax Results

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,
      "qual_id": "text",
      "icon": "text",
      "subtype": "bigquery"
    },
    "attrs": {},
    "parents": [
      {
        "type": "text",
        "name": "text",
        "id": 1,
        "qual_id": "text",
        "icon": "text",
        "subtype": "bigquery"
      }
    ],
    "assets": [
      {
        "type": "text",
        "name": "text",
        "id": 1,
        "qual_id": "text",
        "icon": "text",
        "subtype": "bigquery"
      }
    ]
  }
]

Successful Response

Attach Documentation To Term

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

post

/catalog/glossary/documentation

Body

idIdrequired

documentationDocumentationrequired

typeTyperequired

Options: term

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

200

422

200

No body

Successful Response

Delete Documentation To Term

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

delete

/catalog/glossary/documentation

Query parameters

term_idTerm Idrequired

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