Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Data Assets

Create Data Asset

Use this API to create a new data asset or upsert an existing data asset. Data assets must be added using a structured top-down hierarchy to ensure consistent data organization. The request must include all required data asset details, such as the parent ID, name, type, and data source. The response will confirm successful ingestion with the assigned data asset ID.

Things to Know

  • If terms, tags, additional attributes, or users are added to an existing data asset, the system will merge the new values from the request with the existing values.
  • With the exception of the root (data source) node, every data asset must have its parent record already present in the system before being added.
post/api/data-governance/v1/data-assets

Request body

namestring required

The name of the data asset.

shortDescriptionstring

The description of the data asset.

type'DATASOURCE' | 'DATABASE' | 'OBJECT' | 'SCHEMA' | 'CATALOG' | 'TABLE' | 'COLUMN' | 'FIELD' | 'FOLDER' | 'FILE' | 'DRIVE' | 'FILE_SYSTEM' | 'VIEW' | 'DIRECTORY' required

The type of data asset.

parentIdstring uuid required

The unique identifier of the parent object. This parameter value is null for type: DATASOURCE.

oneTrustSourceSystemIdstring uuid

The unique identifier of the data source.

technicalOwnersstring[]

The unique identifier(s) of the technical owner(s) responsible for managing the technical details of the data asset.

businessOwnersstring[]

The unique identifier(s) of the business owner(s) responsible for defining and updating the business context of the glossary.

dataStewardsstring[]

The unique identifier(s) of the data steward(s) responsible for utilizing data governance processes to ensure data reliability and validity within a data asset or business unit.

piiboolean

This flag indicates whether the data asset is classified as PII.

Example request

{
  "name": "resume.pdf",
  "shortDescription": "Professional resume",
  "dataSource": {
    "id": "9fc8e1a8-b7d1-47c5-8f4b-7ebd451506f8",
    "name": "Onetrust-smb",
    "systemType": "Snowflake"
  },
  "parentId": "de6d404d-14d6-487f-bbf7-fd202bde4768",
  "oneTrustSourceSystemId": "9fc8e1a8-b7d1-47c5-8f4b-7ebd451506f8",
  "technicalOwners": [
    "705992a2-e6a2-4fd7-a3f9-6190caa2365b"
  ],
  "businessOwners": [
    "70ab1943-4b55-41d4-8183-6fa372579c6a"
  ],
  "dataStewards": [
    "32d50775-17c3-44f0-88da-575b8a10c9fb"
  ],
  "pii": true,
  "additionalAttributes": [
    {
      "name": "DS Multi Select",
      "displayName": "DS Multi Select",
      "dataType": "STRING",
      "custom": true
    }
  ],
  "terms": [
    {
      "termId": "29d09995-6040-403f-b520-fa9b38ce0bf5",
      "termName": "Social Security Number"
    }
  ],
  "tags": [
    {
      "tagId": "29d09995-6040-403f-b520-fa9b38ce0bf5",
      "tagName": "Confidential"
    }
  ]
}

Response

Created

idstring uuid

The unique identifier of the data asset.

Example response

{
  "id": "6756206c-845c-4ecc-8826-0e25d12b0d0c"
}