🚧  API Specification Update in Progress: We're migrating our APIs from Swagger 2.0 to OpenAPI 3.1.0. This upgrade brings improved compatibility, flexibility, and support for modern API standards. For more information, see OneTrust API Migration to OpenAPI 3.1.0.

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.
Body Params
string
required
length between 1 and 100

The name of the data asset.

string
length ≤ 4000

The description of the data asset.

dataSource
object
required

The details of the data source.

string
required

The type of data asset.

uuid
required

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

uuid

The unique identifier of the data source.

technicalOwners
array of uuids

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

technicalOwners
businessOwners
array of uuids

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

businessOwners
dataStewards
array of uuids

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.

dataStewards
boolean
Defaults to false

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

additionalAttributes
array of objects

The details of the associated attributes.

additionalAttributes
terms
array of objects

The list of associated terms.

terms
tags
array of objects

The list of associated classification tags.

tags
Responses

name of the Data Asset in the request.
  • Missing dataSource of the Data Asset in the request.
  • Missing type of the Data Asset in the request.
  • Missing parentId for the Data Asset when the asset type is not DataSource.
  • Language
    Credentials
    OAuth2
    URL
    Choose an example:
    application/json
    */*