GlossaryTerm

This schema defines te Glossary term entities.

Properties

• id: Unique identifier of a glossary term instance. Refer to ../../type/basic.json#/definitions/uuid.
• name: Preferred name for the glossary term. Refer to ../../type/basic.json#/definitions/entityName.
• displayName (string): Display Name that identifies this glossary.
• description: Description of the glossary term. Refer to ../../type/basic.json#/definitions/markdown.
• style: Refer to ../../type/basic.json#/definitions/style.
• fullyQualifiedName: A unique name that identifies a glossary term. It captures name hierarchy of glossary of terms in the form of glossaryName.parentTerm.childTerm. Refer to ../../type/basic.json#/definitions/fullyQualifiedEntityName.
• synonyms (array): Alternate names that are synonyms or near-synonyms for the glossary term.
  • Items: Refer to ../../type/basic.json#/definitions/entityName.
• glossary: Glossary that this term belongs to. Refer to ../../type/entityReference.json.
• parent: Parent glossary term that this term is child of. When null this term is the root term of the glossary. Refer to ../../type/entityReference.json.
• children: Other glossary terms that are children of this glossary term. Refer to ../../type/entityReferenceList.json.
• relatedTerms: Other glossary terms that are related to this glossary term. Refer to ../../type/entityReferenceList.json.
• references (array): Link to a reference from an external glossary.
  • Items: Refer to ../../entity/data/glossaryTerm.json#/definitions/termReference.
• version: Metadata version of the entity. Refer to ../../type/entityHistory.json#/definitions/entityVersion.
• updatedAt: Last update time corresponding to the new version of the entity in Unix epoch time milliseconds. Refer to ../../type/basic.json#/definitions/timestamp.
• updatedBy (string): User who made the update.
• href: Link to the resource corresponding to this entity. Refer to ../../type/basic.json#/definitions/href.
• reviewers: User names of the reviewers for this glossary. Refer to ../../type/entityReferenceList.json.
• owners: Owners of this glossary term. Refer to ../../type/entityReferenceList.json.
• usageCount (integer): Count of how many times this and it's children glossary terms are used as labels.
• tags (array): Tags associated with this glossary term. These tags captures relationship of a glossary term with a tag automatically. As an example a glossary term 'User.PhoneNumber' might have an associated tag 'PII.Sensitive'. When 'User.Address' is used to label a column in a table, 'PII.Sensitive' label is also applied automatically due to Associated tag relationship. Default: [].
  • Items: Refer to ../../type/tagLabel.json.
• changeDescription: Change that lead to this version of the entity. Refer to ../../type/entityHistory.json#/definitions/changeDescription.
• status: Status of the glossary term. Refer to #/definitions/status.
• deleted (boolean): When true indicates the entity has been soft deleted. Default: false.
• provider: Refer to ../../type/basic.json#/definitions/providerType.
• disabled (boolean): System glossary can't be deleted. Use this flag to disable them.
• mutuallyExclusive (boolean): Glossary terms that are children of this term are mutually exclusive. When mutually exclusive is true only one term can be used to label an entity from this group. When mutually exclusive is false, multiple terms from this group can be used to label an entity. Default: "false".
• extension: Entity extension data with custom attributes added to the entity. Refer to ../../type/basic.json#/definitions/entityExtension.
• domain: Domain the Glossary Term belongs to. When not set, the Glossary TErm inherits the domain from the Glossary it belongs to. Refer to ../../type/entityReference.json.
• dataProducts: List of data products this entity is part of. Refer to ../../type/entityReferenceList.json.
• votes: Votes on the entity. Refer to ../../type/votes.json.
• childrenCount (integer): Count of immediate children glossary terms.

Definitions

• termReference (object): Cannot contain additional properties.
  • name (string): Name that identifies the source of an external glossary term. Example HealthCare.gov.
  • endpoint (string, format: uri): Name that identifies the source of an external glossary term. Example HealthCare.gov.
• status (string): Must be one of: ["Draft", "In Review", "Approved", "Deprecated", "Rejected"].

Documentation file automatically generated at 2025-01-15 09:05:25.266839+00:00.