PurviewGlossaries.GetTermsByGlossaryNameAsync 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 terms by glossary name.
public virtual System.Threading.Tasks.Task<Azure.Response> GetTermsByGlossaryNameAsync (string glossaryName, int? limit = default, int? offset = default, bool? includeTermHierarchy = default, Azure.RequestContext context = default);
abstract member GetTermsByGlossaryNameAsync : string * Nullable<int> * Nullable<int> * Nullable<bool> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetTermsByGlossaryNameAsync : string * Nullable<int> * Nullable<int> * Nullable<bool> * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
Public Overridable Function GetTermsByGlossaryNameAsync (glossaryName As String, Optional limit As Nullable(Of Integer) = Nothing, Optional offset As Nullable(Of Integer) = Nothing, Optional includeTermHierarchy As Nullable(Of Boolean) = Nothing, Optional context As RequestContext = Nothing) As Task(Of Response)
Parameters
- glossaryName
- String
The name of the glossary.
- context
- RequestContext
The request context, which can override default behaviors on the request on a per-call basis.
Returns
Exceptions
glossaryName
is null.
glossaryName
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
}
Applies to
Collabora con noi su GitHub
L'origine di questo contenuto è disponibile in GitHub, in cui è anche possibile creare ed esaminare i problemi e le richieste pull. Per ulteriori informazioni, vedere la guida per i collaboratori.