PurviewGlossaries.GetGlossaryTermsAsync Method

Definition

Namespace:

Azure.Analytics.Purview.Catalog

Assembly:

Azure.Analytics.Purview.Catalog.dll

Package:

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

Source:

PurviewGlossaries.cs

Get terms belonging to a specific glossary.

public virtual System.Threading.Tasks.Task<Azure.Response> GetGlossaryTermsAsync (string glossaryGuid, bool? includeTermHierarchy = default, int? limit = default, int? offset = default, string sort = default, Azure.RequestContext context = default);

abstract member GetGlossaryTermsAsync : string * Nullable<bool> * Nullable<int> * Nullable<int> * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetGlossaryTermsAsync : string * Nullable<bool> * Nullable<int> * Nullable<int> * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function GetGlossaryTermsAsync (glossaryGuid As String, Optional includeTermHierarchy As Nullable(Of Boolean) = Nothing, Optional limit As Nullable(Of Integer) = Nothing, Optional offset As Nullable(Of Integer) = Nothing, Optional sort As String = Nothing, Optional context As RequestContext = Nothing) As Task(Of Response)

Parameters

glossaryGuid

String

The globally unique identifier for glossary.

includeTermHierarchy

Nullable<Boolean>

Whether include term hierarchy.

limit

Nullable<Int32>

The page size - by default there is no paging.

offset

Nullable<Int32>

The offset for pagination purpose.

sort

String

The sort order, ASC (default) or DESC.

context

RequestContext

The request context, which can override default behaviors on the request on a per-call basis.

Returns

Task<Response>

Exceptions

ArgumentNullException

glossaryGuid is null.

ArgumentException

glossaryGuid 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
            }