Glossary

Get Glossary Object

Get a glossary object by ID and AssetType

GEThttps://connect.decube.io/api/v1/data/catalog/glossary

Query parameters

Response

200422

Successful Response

Body

application/json

asset*DataAssets

parents*Parents

attrs*Attrs

Request

JavaScriptCurlPython

const response = await fetch('https://connect.decube.io/api/v1/data/catalog/glossary?id=0&type=glossary', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

{
  "asset": {
    "type": "text",
    "name": "text",
    "id": 0,
    "subtype": "bigquery",
    "qual_id": "text",
    "icon": "text"
  },
  "parents": [
    {
      "type": "text",
      "name": "text",
      "id": 0,
      "subtype": "bigquery",
      "qual_id": "text",
      "icon": "text"
    }
  ]
}

Create Glossary Object

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

POSThttps://connect.decube.io/api/v1/data/catalog/glossary

Body

application/json

Body

CreateGlossaryBodyCreateCategoryBodyCreateTermBody

Response

200422

Successful Response

Body

application/json

id*Id

type*Type

glossarycategoryterm

Request

JavaScriptCurlPython

const response = await fetch('https://connect.decube.io/api/v1/data/catalog/glossary', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "type": "glossary",
      "name": "text"
    }),
});
const data = await response.json();

Response

200422

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

Delete Glossary Object

Deletes an existing glossary object.

DELETEhttps://connect.decube.io/api/v1/data/catalog/glossary

Query parameters

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://connect.decube.io/api/v1/data/catalog/glossary?id=0&type=glossary', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

Modify Glossary Object

Modifies an existing glossary object.

PATCHhttps://connect.decube.io/api/v1/data/catalog/glossary

Body

application/json

Body

ModifyGlossaryBodyModifyCategoryBodyModifyTermBody

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://connect.decube.io/api/v1/data/catalog/glossary', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": 0,
      "type": "glossary"
    }),
});
const data = await response.json();

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

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.

GEThttps://connect.decube.io/api/v1/data/catalog/glossary/list

Query parameters

Response

200422

Successful Response

Body

application/json

asset*DataAssets

parents*Parents

attrs*Attrs

Request

JavaScriptCurlPython

const response = await fetch('https://connect.decube.io/api/v1/data/catalog/glossary/list', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

[
  {
    "asset": {
      "type": "text",
      "name": "text",
      "id": 0,
      "subtype": "bigquery",
      "qual_id": "text",
      "icon": "text"
    },
    "parents": [
      {
        "type": "text",
        "name": "text",
        "id": 0,
        "subtype": "bigquery",
        "qual_id": "text",
        "icon": "text"
      }
    ]
  }
]

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.

GEThttps://connect.decube.io/api/v1/data/catalog/glossary/search

Query parameters

Response

200422

Successful Response

Body

application/json

asset*DataAssets

parents*Parents

attrs*Attrs

Request

JavaScriptCurlPython

const response = await fetch('https://connect.decube.io/api/v1/data/catalog/glossary/search', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200422

[
  {
    "asset": {
      "type": "text",
      "name": "text",
      "id": 0,
      "subtype": "bigquery",
      "qual_id": "text",
      "icon": "text"
    },
    "parents": [
      {
        "type": "text",
        "name": "text",
        "id": 0,
        "subtype": "bigquery",
        "qual_id": "text",
        "icon": "text"
      }
    ]
  }
]

Attach Documentation To Term

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

POSThttps://connect.decube.io/api/v1/data/catalog/glossary/documentation

Body

application/json

id*Id

type*Type

term

documentation*Documentation

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://connect.decube.io/api/v1/data/catalog/glossary/documentation', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "id": 0,
      "type": "term"
    }),
});
const data = await response.json();

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

Delete Documentation To Term

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

DELETEhttps://connect.decube.io/api/v1/data/catalog/glossary/documentation

Query parameters

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://connect.decube.io/api/v1/data/catalog/glossary/documentation?term_id=0', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}