Attach classification

POST /api/meta/entity/bulk/classification/displayName

Attach a classification to an asset using the display name of the classification (in the Atlan UI) and the GUID of the entity to which to attach it.

Body Required

List of attachments between assets and classifications.

  • entityGuid string Required

    Unique identifier of the asset for which the classification is to be added.

  • displayName string Required

    Name of the classification that is to be attached to the asset.

  • propagate boolean

    When true, propagates the classification to child assets. This includes contained children (e.g. from a table to all columns in the table) and to downstream assets via lineage.

  • removePropagationsOnEntityDelete boolean

    When true, propagates the removal of a classification to child assets. This includes contained children (e.g. from a table to all columns in the table) and to downstream assets via lineage.

Responses

  • • 204

    Successfully attached classifications to entities.

  • • 400 object

    Error when attaching the classification. For example, if the provided entity and classification are already attached.

    • 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/bulk/classification/displayName 
curl \
 -X POST https://tenant.atlan.com/api/meta/entity/bulk/classification/displayName \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '[{"entityGuid":"bdcbd27e-153e-4e86-ba50-ecea60097018","displayName":"PII","propagate":true,"removePropagationsOnEntityDelete":true}]'
Request example 
[
  {
    "entityGuid": "bdcbd27e-153e-4e86-ba50-ecea60097018",
    "displayName": "PII",
    "propagate": true,
    "removePropagationsOnEntityDelete": true
  }
]
Response example (400) 
{
  "errorCode": "ATLAS-400-00-01A",
  "errorMessage": "invalid parameters: entity: 4961767f-a26e-4d4f-bf3c-b28320a4f3aa, already associated with classification: DbEq9WxfnHlXxPejKu9Nec"
}