main-concepts

No menu items for this category
OpenMetadata Documentation

CreateTagRequest

Create tag API request

  • classification: Name of the classification that this tag is part of. Refer to ../../type/basic.json#/definitions/fullyQualifiedEntityName.
  • parent: Fully qualified name of the parent tag. When null, the term is at the root of the classification. Refer to ../../type/basic.json#/definitions/fullyQualifiedEntityName.
  • name: Refer to ../../type/basic.json#/definitions/entityName.
  • displayName (string): Display Name that identifies this tag.
  • description: Unique name of the classification. Refer to ../../type/basic.json#/definitions/markdown.
  • style: Refer to ../../type/basic.json#/definitions/style.
  • associatedTags (array): Fully qualified names of tags associated with this tag.
    • Items (string)
  • provider: Refer to ../../type/basic.json#/definitions/providerType.
  • mutuallyExclusive (boolean): Children tags under this group are mutually exclusive. When mutually exclusive is true the tags from this group are used to classify an entity. An entity can only be in one class - example, it can only be either tier1 or tier2 and not both. When mutually exclusive is false, the tags from this group are used to categorize an entity. An entity can be in multiple categories simultaneously - example a customer can be newCustomer and atRisk simultaneously. Default: False.
  • domains (array): Fully qualified names of the domains the Tag belongs to.
    • Items (string)
  • owners: Owners of this glossary term. Refer to ../../type/entityReferenceList.json.

Documentation file automatically generated at 2025-08-12 05:39:47.683420+00:00.