Data Assets

Modify Data Asset

Use this API to modify existing data assets while maintaining a structured top-down hierarchy. With this API, the system will replace existing terms, tags, additional attributes, or users with the new data included in the request. The response will confirm the status along with the updated data asset ID.

patch/api/data-governance/v1/data-assets/{dataAssetId}

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/api/data-governance/v1/data-assets/{dataAssetId}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: DATA_CATALOG_WRITE

Path parameters

dataAssetIdstring uuid required

The unique identifier of the data asset.

Request body

shortDescriptionstring

Short Description of the Data Asset

oneTrustSourceSystemIdstring uuid

Unique identifier of the Onetrust Source System

technicalOwnersstring[]
businessOwnersstring[]
dataStewardsstring[]
piiboolean

Indicates whether Data Asset is classified as PII or not

Example request

{
  "shortDescription": "Professional resume",
  "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

OK

idstring uuid

The unique identifier of the data asset.

Example response

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

Changes

No recorded changes to this operation across all 1 revision of this API.