Attach custom metadata

POST /api/meta/entity/guid/{guid}/businessmetadata/displayName

Attach custom metadata to an asset (table, schema, etc) by its GUID. This is used to populate any of the custom metadata attributes on any type of asset.

Path parameters

  • guid string(uuid) Required

    Unique identifier of the entity to retrieve.

Query parameters

  • isOverwrite boolean

    When true, will act as a full replacement of custom metadata: any custom metadata not provided in the request body will have any existing value removed from the asset. When false, will act as a partial update of the custom metadata: only the attributes provided in the request body will be updated, and any other custom metadata attributes will be left as-is on the asset.

Body Required

Map of custom metadata types, with nested maps of their attributes and values to set on the asset.

  • Custom metadata name object

    Display name of the custom metadata as it appears on the Atlan UI. In the example, this is Additional contributors

Responses

  • • 204

    Custom metadata was successfully attached or updated.

  • • 404 object

    Entity does not exist, or is deleted.

    • errorCode string

      Unique code for the type of error that occurred.

    • errorMessage string

      Human-readable description of the error that occurred.

POST /api/meta/entity/guid/{guid}/businessmetadata/displayName 
curl \
 -X POST https://tenant.atlan.com/api/meta/entity/guid/917ffec9-fa84-4c59-8e6c-c7b114d04be3/businessmetadata/displayName \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"Additional contributors":{"Data experts":["jsmith","jdoe"]}}'
Request example 
{
  "Additional contributors": {
    "Data experts": [
      "jsmith",
      "jdoe"
    ]
  }
}
Response example (404) 
{
  "errorCode": "ATLAS-404-00-005",
  "errorMessage": "Given instance guid abc123 is invalid/not found\n"
}