PurviewGlossaries.GetGlossaryCategories メソッド

定義

名前空間:

Azure.Analytics.Purview.Catalog

アセンブリ:

Azure.Analytics.Purview.Catalog.dll

パッケージ:

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

ソース:

PurviewGlossaries.cs

特定の用語集に属するカテゴリを取得します。

public virtual Azure.Response GetGlossaryCategories (string glossaryGuid, int? limit = default, int? offset = default, string sort = default, Azure.RequestContext context = default);

abstract member GetGlossaryCategories : string * Nullable<int> * Nullable<int> * string * Azure.RequestContext -> Azure.Response
override this.GetGlossaryCategories : string * Nullable<int> * Nullable<int> * string * Azure.RequestContext -> Azure.Response

Public Overridable Function GetGlossaryCategories (glossaryGuid As String, 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 Response

パラメーター

glossaryGuid

String

用語集のグローバル一意識別子。

limit

Nullable<Int32>

ページ サイズ - 既定ではページングはありません。

offset

Nullable<Int32>

改ページ位置のオフセット。

sort

String

並べ替え順序、ASC (既定) または DESC。

context

RequestContext

要求コンテキスト。これは、呼び出しごとに要求の既定の動作をオーバーライドできます。

戻り値

Response

例外

ArgumentNullException

glossaryGuid が null です。

ArgumentException

glossaryGuid は空の文字列であり、空でないと予想されていました。

注釈

の 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,
              anchor: {
                displayText: string,
                glossaryGuid: string,
                relationGuid: string
              },
              childrenCategories: [
                {
                  categoryGuid: string,
                  description: string,
                  displayText: string,
                  parentCategoryGuid: string,
                  relationGuid: string
                }
              ],
              parentCategory: AtlasRelatedCategoryHeader,
              terms: [
                {
                  description: string,
                  displayText: string,
                  expression: string,
                  relationGuid: string,
                  source: string,
                  status: "DRAFT" | "ACTIVE" | "DEPRECATED" | "OBSOLETE" | "OTHER",
                  steward: string,
                  termGuid: string
                }
              ]
            }

の Response Errorスキーマ:

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