PurviewGlossaries.GetGlossaryTermAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Get a specific glossary term by its GUID.
public virtual System.Threading.Tasks.Task<Azure.Response> GetGlossaryTermAsync (string termGuid, bool? includeTermHierarchy = default, System.Collections.Generic.IEnumerable<string> excludeRelationshipTypeList = default, Azure.RequestContext context = default);
abstract member GetGlossaryTermAsync : string * Nullable<bool> * seq<string> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetGlossaryTermAsync : string * Nullable<bool> * seq<string> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
Public Overridable Function GetGlossaryTermAsync (termGuid As String, Optional includeTermHierarchy As Nullable(Of Boolean) = Nothing, Optional excludeRelationshipTypeList As IEnumerable(Of String) = Nothing, Optional context As RequestContext = Nothing) As Task(Of Response)
Parameters
- termGuid
- String
The globally unique identifier for glossary term.
- excludeRelationshipTypeList
- IEnumerable<String>
An array of relationship types which need to be excluded.
- context
- RequestContext
The request context, which can override default behaviors on the request on a per-call basis.
Returns
Exceptions
termGuid
is null.
termGuid
is an empty string, and was expected to be non-empty.
Remarks
Schema for Response Body
:
{
classifications: [
{
attributes: Dictionary<string, AnyObject>,
typeName: string,
lastModifiedTS: string,
entityGuid: string,
entityStatus: "ACTIVE" | "DELETED",
removePropagationsOnEntityDelete: boolean,
validityPeriods: [
{
endTime: string,
startTime: string,
timeZone: string
}
],
source: string,
sourceDetails: Dictionary<string, AnyObject>
}
],
longDescription: string,
name: string,
qualifiedName: string,
shortDescription: string,
lastModifiedTS: string,
guid: string,
abbreviation: string,
templateName: [AnyObject],
anchor: {
displayText: string,
glossaryGuid: string,
relationGuid: string
},
antonyms: [
{
description: string,
displayText: string,
expression: string,
relationGuid: string,
source: string,
status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER",
steward: string,
termGuid: string
}
],
createTime: number,
createdBy: string,
updateTime: number,
updatedBy: string,
status: "Draft" | "Approved" | "Alert" | "Expired",
resources: [
{
displayName: string,
url: string
}
],
contacts: Dictionary<string, ContactBasic[]>,
attributes: Dictionary<string, Dictionary<string, AnyObject>>,
assignedEntities: [
{
guid: string,
typeName: string,
uniqueAttributes: Dictionary<string, AnyObject>,
displayText: string,
entityStatus: "ACTIVE" | "DELETED",
relationshipType: string,
relationshipAttributes: {
attributes: Dictionary<string, AnyObject>,
typeName: string,
lastModifiedTS: string
},
relationshipGuid: string,
relationshipStatus: "ACTIVE" | "DELETED"
}
],
categories: [
{
categoryGuid: string,
description: string,
displayText: string,
relationGuid: string,
status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER"
}
],
classifies: [AtlasRelatedTermHeader],
examples: [string],
isA: [AtlasRelatedTermHeader],
preferredTerms: [AtlasRelatedTermHeader],
preferredToTerms: [AtlasRelatedTermHeader],
replacedBy: [AtlasRelatedTermHeader],
replacementTerms: [AtlasRelatedTermHeader],
seeAlso: [AtlasRelatedTermHeader],
synonyms: [AtlasRelatedTermHeader],
translatedTerms: [AtlasRelatedTermHeader],
translationTerms: [AtlasRelatedTermHeader],
usage: string,
validValues: [AtlasRelatedTermHeader],
validValuesFor: [AtlasRelatedTermHeader]
}
Schema for Response Error
:
{
requestId: string,
errorCode: string,
errorMessage: string
}