AtlasGlossaryTermOutput interface

Package:

@azure-rest/purview-datamap

The glossary term.

Properties

abbreviation	The abbreviation of the term.
anchor	The glossary header with basic information.
antonyms	An array of related term headers as antonyms.
assignedEntities	An array of related object IDs.
attributes	The custom attributes of the term, which is map<string,map<string,object>>. The key of the first layer map is term template name.
categories	An array of term categorization headers.
classifications	An array of classifications.
classifies	An array of related term headers.
contacts	The dictionary of contacts for terms. Key could be Expert or Steward.
createdBy	The user who created the record.
createTime	The created time of the record.
examples	An array of examples.
guid	The GUID of the object.
hierarchyInfo	The hierarchy information of the term.
isA	An array of related term headers indicating the is-a relationship.
lastModifiedTS	ETag for concurrency control.
longDescription	The long version description.
name	The name of the glossary object.
nickName	The nick name of the term.
preferredTerms	An array of preferred related term headers.
preferredToTerms	An array of related term headers that are preferred to.
qualifiedName	The qualified name of the glossary object.
replacedBy	An array of related term headers that are replaced by.
replacementTerms	An array of related term headers for replacement.
resources	An array of resource link for term
seeAlso	An array of related term headers for see also.
shortDescription	The short version of description.
status	Status of the AtlasGlossaryTerm Possible values: "Draft", "Approved", "Alert", "Expired"
synonyms	An array of related term headers as synonyms.
templateName	The name of the template.
translatedTerms	An array of translated related term headers.
translationTerms	An array of related term headers for translation.
updatedBy	The user who updated the record.
updateTime	The update time of the record.
usage	The usage of the term.
validValues	An array of related term headers as valid values.
validValuesFor	An array of related term headers as valid values for other records.

Property Details

abbreviation

The abbreviation of the term.

abbreviation?: string

Property Value

string

anchor

The glossary header with basic information.

anchor?: AtlasGlossaryHeaderOutput

Property Value

AtlasGlossaryHeaderOutput

antonyms

An array of related term headers as antonyms.

antonyms?: AtlasRelatedTermHeaderOutput[]

Property Value

AtlasRelatedTermHeaderOutput[]

assignedEntities

An array of related object IDs.

assignedEntities?: AtlasRelatedObjectIdOutput[]

Property Value

AtlasRelatedObjectIdOutput[]

attributes

The custom attributes of the term, which is map<string,map<string,object>>. The key of the first layer map is term template name.

attributes?: Record<string, Record<string, any>>

Property Value

Record<string, Record<string, any>>

categories

An array of term categorization headers.

categories?: AtlasTermCategorizationHeaderOutput[]

Property Value

AtlasTermCategorizationHeaderOutput[]

classifications

An array of classifications.

classifications?: AtlasClassificationOutput[]

Property Value

AtlasClassificationOutput[]

classifies

An array of related term headers.

classifies?: AtlasRelatedTermHeaderOutput[]

Property Value

AtlasRelatedTermHeaderOutput[]

contacts

The dictionary of contacts for terms. Key could be Expert or Steward.

contacts?: Record<string, ContactInfoOutput[]>

Property Value

Record<string, ContactInfoOutput[]>

createdBy

The user who created the record.

createdBy?: string

Property Value

string

createTime

The created time of the record.

createTime?: number

Property Value

number

examples

An array of examples.

examples?: string[]

Property Value

string[]

guid

The GUID of the object.

guid?: string

Property Value

string

hierarchyInfo

The hierarchy information of the term.

hierarchyInfo?: PurviewObjectIdOutput[]

Property Value

PurviewObjectIdOutput[]

isA

An array of related term headers indicating the is-a relationship.

isA?: AtlasRelatedTermHeaderOutput[]

Property Value

AtlasRelatedTermHeaderOutput[]

lastModifiedTS

ETag for concurrency control.

lastModifiedTS?: string

Property Value

string

longDescription

The long version description.

longDescription?: string

Property Value

string

name

The name of the glossary object.

name?: string

Property Value

string

nickName

The nick name of the term.

nickName?: string

Property Value

string

preferredTerms

An array of preferred related term headers.

preferredTerms?: AtlasRelatedTermHeaderOutput[]

Property Value

AtlasRelatedTermHeaderOutput[]

preferredToTerms

An array of related term headers that are preferred to.

preferredToTerms?: AtlasRelatedTermHeaderOutput[]

Property Value

AtlasRelatedTermHeaderOutput[]

qualifiedName

The qualified name of the glossary object.

qualifiedName?: string

Property Value

string

replacedBy

An array of related term headers that are replaced by.

replacedBy?: AtlasRelatedTermHeaderOutput[]

Property Value

AtlasRelatedTermHeaderOutput[]

replacementTerms

An array of related term headers for replacement.

replacementTerms?: AtlasRelatedTermHeaderOutput[]

Property Value

AtlasRelatedTermHeaderOutput[]

resources

An array of resource link for term

resources?: ResourceLinkOutput[]

Property Value

ResourceLinkOutput[]

seeAlso

An array of related term headers for see also.

seeAlso?: AtlasRelatedTermHeaderOutput[]

Property Value

AtlasRelatedTermHeaderOutput[]

shortDescription

The short version of description.

shortDescription?: string

Property Value

string

status

Status of the AtlasGlossaryTerm

Possible values: "Draft", "Approved", "Alert", "Expired"

status?: string

Property Value

string

synonyms

An array of related term headers as synonyms.

synonyms?: AtlasRelatedTermHeaderOutput[]

Property Value

AtlasRelatedTermHeaderOutput[]

templateName

The name of the template.

templateName?: any[]

Property Value

any[]

translatedTerms

An array of translated related term headers.

translatedTerms?: AtlasRelatedTermHeaderOutput[]

Property Value

AtlasRelatedTermHeaderOutput[]

translationTerms

An array of related term headers for translation.

translationTerms?: AtlasRelatedTermHeaderOutput[]

Property Value

AtlasRelatedTermHeaderOutput[]

updatedBy

The user who updated the record.

updatedBy?: string

Property Value

string

updateTime

The update time of the record.

updateTime?: number

Property Value

number

usage

The usage of the term.

usage?: string

Property Value

string

validValues

An array of related term headers as valid values.

validValues?: AtlasRelatedTermHeaderOutput[]

Property Value

AtlasRelatedTermHeaderOutput[]

validValuesFor

An array of related term headers as valid values for other records.

validValuesFor?: AtlasRelatedTermHeaderOutput[]

Property Value

AtlasRelatedTermHeaderOutput[]