Decube
Try for free
  • ๐Ÿš€Overview
    • Welcome to decube
    • Getting started
      • How to connect data sources
    • Security and Compliance
    • Data Policy
    • Changelog
    • Public Roadmap
  • Support
  • ๐Ÿ”ŒData Warehouses
    • Snowflake
    • Redshift
    • Google Bigquery
    • Databricks
    • Azure Synapse
  • ๐Ÿ”ŒRelational Databases
    • PostgreSQL
    • MySQL
    • SingleStore
    • Microsoft SQL Server
    • Oracle
  • ๐Ÿ”ŒTransformation Tools
    • dbt (Cloud Version)
    • dbt Core
    • Fivetran
    • Airflow
    • AWS Glue
    • Azure Data Factory
    • Apache Spark
      • Apache Spark in Azure Synapse
    • OpenLineage (BETA)
    • Additional configurations
  • ๐Ÿ”ŒBusiness Intelligence
    • Tableau
    • Looker
    • PowerBI
  • ๐Ÿ”ŒData Lake
    • AWS S3
    • Azure Data Lake Storage (ADLS)
      • Azure Function for Metadata
    • Google Cloud Storage (GCS)
  • ๐Ÿ”ŒTicketing and Collaboration
    • ServiceNow
    • Jira
  • ๐Ÿ”’Security and Connectivity
    • Enabling VPC Access
    • IP Whitelisting
    • SSH Tunneling
    • AWS Identities
  • โœ…Data Quality
    • Incidents Overview
    • Incident model feedback
    • Enable asset monitoring
    • Available Monitor Types
    • Available Monitor Modes
    • Catalog: Add/Modify Monitor
    • Set Up Freshness & Volume Monitors
    • Set Up Field Health Monitors
    • Set Up Custom SQL Monitors
    • Grouped-by Monitors
    • Modify Schema Drift Monitors
    • Modify Job Failure Monitors (Data Job)
    • Custom Scheduling For Monitors
    • Config Settings
  • ๐Ÿ“–Catalog
    • Overview of Asset Types
    • Assets Catalog
    • Asset Overview
    • Automated Lineage
      • Lineage Relationship
      • Supported Data Sources and Lineage Types
    • Add lineage relationships manually
    • Add tags and classifications to fields
    • Field Statistcs
    • Preview sample data
  • ๐Ÿ“šGlossary
    • Glossary, Category and Terms
    • Adding a new glossary
    • Adding Terms and Linked Assets
  • Moving Terms to Glossary/Category
  • AI Copilot
    • Copilot's Autocomplete
  • ๐ŸคCollaboration
    • Ask Questions
    • Rate an asset
  • ๐ŸŒData Mesh [BETA]
    • Overview on Data Mesh [BETA]
    • Creating and Managing Domains/Sub-domains
    • Adding members to Domain/Sub-domain
    • Linking Entities to Domains/Sub-domains
    • Adding Data Products to Domains/Subdomains
    • Creating a draft Data Asset
    • Adding a Data Contract - Default Settings
    • Adding a Data Contract - Freshness Test
    • Adding a Data Contract - Column Tests
    • Publishing the Data Asset
  • ๐Ÿ›๏ธGovernance
    • Governance module
    • Classification Policies
    • Auto-classify data assets
  • โ˜‘๏ธApproval Workflow
    • What are Change Requests?
    • Initiate a change request
    • What are Access Requests?
    • Initiate an Access Request
  • ๐Ÿ“‹Reports
    • Overview of Reports
    • Supported sources for Reports
    • Asset Report: Data Quality Scorecard
  • ๐Ÿ“ŠDashboard
    • Dashboard Overview
    • Incidents
    • Quality
  • โฐAlert Notifications
    • Get alerts on email
    • Connect your Slack channels
    • Connect to Microsoft Teams
    • Webhooks integration
  • ๐Ÿ›๏ธManage Access
    • User Management - Overview
    • Invite users
    • Deactivate or re-activate users
    • Revoke a user invite
  • ๐Ÿ”Group-based Access Controls
    • Groups Management - Overview
    • Create Groups & Assign Policies
    • Source-based Policies
    • Administrative-based Policies
    • Module-based Policies
    • What is the "Owners" group?
  • ๐Ÿ—„๏ธOrg Settings
    • Multi-factor authentication
    • Single Sign-On (SSO) with Microsoft
    • Single Sign-On (SSO) with JumpCloud
  • โ“Support
    • Supported Features by Integration
    • Frequently Asked Questions
    • Supported Browsers and System Requirements
  • Public API (BETA)
    • Overview
      • Data API
        • Glossary
        • Lineage
        • ACL
          • Group
      • Control API
        • Users
    • API Keys
Powered by GitBook
On this page
  1. Public API (BETA)
  2. Overview
  3. Data API

Glossary

PreviousData APINextLineage

Last updated 4 months ago

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

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

Possible values:
typestring ยท enumOptional

Filters the result to only contain glossary objects of this type

Possible values:
page_sizeinteger ยท min: 1 ยท max: 100OptionalDefault: 10
pageinteger ยท min: 1OptionalDefault: 1
Responses
200
Successful Response
application/json
422
Validation Error
application/json
get
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

Possible values:
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
200
Successful Response
application/json
422
Validation Error
application/json
get
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": {}
  }
]

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

No content

  • GETGet Glossary Object
  • POSTCreate Glossary Object
  • DELETEDelete Glossary Object
  • PATCHModify Glossary Object
  • GETList Glossary Objects
  • GETSearch Glossary Objects
  • POSTAttach Documentation To Term
  • DELETEDelete Documentation To Term

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
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
or
or
Responses
200
Successful Response
application/json
422
Validation Error
application/json
post
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"
}

Modify Glossary Object

patch

Modifies an existing glossary object.

Body
any ofOptional
or
or
Responses
200
Successful Response
application/json
Responseany
422
Validation Error
application/json
patch
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

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 ยท enumRequiredPossible values:
documentationobject ยท DocumentationRequired
Responses
200
Successful Response
application/json
Responseany
422
Validation Error
application/json
post
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