PurviewGlossaries.GetTermsByGlossaryNameAsync Método

Definição

Namespace:

Azure.Analytics.Purview.Catalog

Assembly:

Azure.Analytics.Purview.Catalog.dll

Pacote:

Azure.Analytics.Purview.Catalog v1.0.0-beta.4

Origem:

PurviewGlossaries.cs

Obter termos por nome do glossário.

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)

Parâmetros

glossaryName

String

O nome do glossário.

limit

Nullable<Int32>

O tamanho da página – por padrão, não há paginação.

offset

Nullable<Int32>

O deslocamento para fins de paginação.

includeTermHierarchy

Nullable<Boolean>

Se incluir hierarquia de termos.

context

RequestContext

O contexto de solicitação, que pode substituir comportamentos padrão na solicitação por chamada.

Retornos

Task<Response>

Exceções

ArgumentNullException

glossaryName é nulo.

ArgumentException

glossaryName é uma cadeia de caracteres vazia e era esperado que não estivesse vazio.

Comentários

Esquema para 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]
            }

Esquema para Response Error:

{
              requestId: string,
              errorCode: string,
              errorMessage: string
            }