Skip to main content

Tags

A Tag is a label within a classification that can be applied to data assets for categorization and governance. Tags can be hierarchically nested within a classification.
Entity schema follows the OpenMetadata Standard.

Entity Hierarchy

Tags belong to a Classification and can be nested:

Fully Qualified Name

The FQN format for a tag is:
For nested tags:
For example: Certification.Bronze or PII.Sensitive.SSN

API Endpoints

Bulk Add and Remove Tags on Assets

Use these endpoints to apply or remove the tag on many assets in one request: The request body takes an assets array of entity references (id and type) and an optional dryRun flag.

Reading the Result

Each asset is authorized and saved on its own. An asset the caller cannot edit does not fail the whole request with 403. It is reported as a failed row with the reason, and the other assets are still updated.
  • Response: The request starts a background job and returns a jobId and a started message. The result for all assets is delivered when the job completes.
  • status: success when every asset was updated, partialSuccess when some were and some were not, and failure when none were.
  • numberOfRowsProcessed, numberOfRowsPassed, numberOfRowsFailed: Counts of assets in the request, updated, and not updated.
  • successRequest: One entry per updated asset.
  • failedRequest: One entry per asset that was not updated. Each has the request (the asset reference) and a message with the reason, for example that the caller lacks permission to edit it.
Clients must read status and failedRequest from the job result, not only the HTTP status code. A response of 200 does not mean every asset was updated.
The domain and data product assets/add and assets/remove endpoints are different: they still return 403 when the caller lacks permission.