main-concepts

No menu items for this category

TagLabel

This schema defines the type for labeling an entity with a Tag.

  • tagFQN: Refer to #/definitions/tagFQN.
  • name (string): Name of the tag or glossary term.
  • displayName (string): Display Name that identifies this tag.
  • description: Description for the tag label. Refer to ../type/basic.json#/definitions/markdown.
  • style: Refer to ../type/basic.json#/definitions/style.
  • source: Label is from Tags or Glossary. Refer to #/definitions/TagSource.
  • labelType (string): Label type describes how a tag label was applied. 'Manual' indicates the tag label was applied by a person. 'Derived' indicates a tag label was derived using the associated tag relationship (see Classification.json for more details). 'Propagatedindicates a tag label was propagated from upstream based on lineage. 'Automated' is used when a tool was used to determine the tag label. Must be one of:['Manual', 'Propagated', 'Automated', 'Derived']. Default: Manual`.
  • state (string): 'Suggested' state is used when a tag label is suggested by users or tools. Owner of the entity must confirm the suggested labels before it is marked as 'Confirmed'. Must be one of: ['Suggested', 'Confirmed']. Default: Confirmed.
  • href: Link to the tag resource. Refer to basic.json#/definitions/href.
  • tagFQN (string)
  • TagSource (string): Must be one of: ['Classification', 'Glossary']. Default: Classification.

Documentation file automatically generated at 2023-10-27 13:55:46.343512.