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: 
Classification
├── Tag (top-level)
│   ├── Tag (child)
│   └── Tag (child)
└── Tag (top-level)

​
Fully Qualified Name

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

​
API Endpoints

MethodEndpointDescription
PUT/v1/tagsCreate or update a tag
POST/v1/tagsCreate a tag (POST variant)
GET/v1/tagsList tags
GET/v1/tags/{id}Get by ID
GET/v1/tags/name/{fqn}Get by FQN
PATCH/v1/tags/{id}Update by ID
PATCH/v1/tags/name/{fqn}Update by name
DELETE/v1/tags/{id}Delete by ID
DELETE/v1/tags/name/{fqn}Delete by name
PUT/v1/tags/restoreRestore soft-deleted tag
GET/v1/tags/{id}/versionsList versions
GET/v1/tags/{id}/versions/{version}Get specific version