Glossary - List

リファレンス

サービス:: Purview

API バージョン:: 2023-09-01

すべての用語集を取得します。改ページ位置の結果を取得するには、limit/offset を使用することをお勧めします。 'ignoreTermsAndCategories=true' を使用し、'GET /datamap/api/atlas/v2/glossary/{glossaryId}/terms' と 'GET '/datamap/api/atlas/v2/glossary/{glossaryId}/categories' を使用して用語/カテゴリを個別にフェッチすることをお勧めします。

GET {endpoint}/datamap/api/atlas/v2/glossary

省略可能なパラメーターを含む:

GET {endpoint}/datamap/api/atlas/v2/glossary?api-version=2023-09-01&limit={limit}&offset={offset}&sort={sort}&ignoreTermsAndCategories={ignoreTermsAndCategories}

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string
api-version	query		string	この操作に使用する API バージョン。
ignoreTermsAndCategories	query		boolean	用語とカテゴリを無視するかどうか
limit	query		integer int32	ページサイズ - 既定ではページングはありません。
offset	query		integer int32	改ページ位置を示すオフセット。
sort	query		string	並べ替え順序、ASC (既定) または DESC。

応答

名前	型	説明
200 OK	AtlasGlossary[]	要求は成功しました。
Other Status Codes	AtlasErrorResponse	予期しないエラー応答。

セキュリティ

OAuth2Auth

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
https://purview.azure.net/.default

例

Glossary_List

要求のサンプル

HTTP

GET {endpoint}/datamap/api/atlas/v2/glossary?api-version=2023-09-01&limit=1&offset=0&sort=ASC

応答のサンプル

状態コード:: 200

[
  {
    "guid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
    "qualifiedName": "Glossary",
    "name": "Glossary",
    "shortDescription": "Example Short Description",
    "longDescription": "Example Long Description",
    "lastModifiedTS": "1",
    "language": "en",
    "usage": "Example Glossary",
    "createdBy": "ExampleCreator",
    "updatedBy": "ExampleUpdator",
    "createTime": 1672892675688,
    "updateTime": 1672892675688,
    "terms": [
      {
        "termGuid": "54688d39-b298-4104-9e80-f2a16f44aaea",
        "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0",
        "displayText": "ExampleTerm1"
      },
      {
        "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008",
        "relationGuid": "9385640b-e6be-437d-a6b9-62d11c14a189",
        "displayText": "ExampleTerm2"
      }
    ],
    "categories": [
      {
        "categoryGuid": "0d6766f6-f4b6-435b-bda2-d3edc358998e",
        "parentCategoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
        "relationGuid": "26a486a4-a8e2-483c-8a84-3b88e909f8d2",
        "displayText": "ExampleCategory3"
      },
      {
        "categoryGuid": "ed7458f0-9463-48a5-b5c6-4f785fb34e12",
        "parentCategoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a",
        "relationGuid": "7bdcef93-a57a-4d1d-95ab-9d3036f394a0",
        "displayText": "ExampleCategory1"
      },
      {
        "categoryGuid": "e47c4584-daca-4f9e-9092-194e04692c9a",
        "relationGuid": "94071e56-fd3e-4441-93ff-1834f818482d",
        "displayText": "ExampleCategory2"
      }
    ]
  }
]

定義

名前	説明
AtlasClassification	分類のインスタンス。ID がありません。このオブジェクトはエンティティに関連付けられている場合にのみ存在します。
AtlasErrorResponse	サービスからのエラー応答
AtlasGlossary	用語集オブジェクト。
AtlasRelatedCategoryHeader	関連するカテゴリのヘッダー。
AtlasRelatedTermHeader	関連する用語のヘッダー。
AtlasTermRelationshipStatus	Atlas 用語リレーションシップの状態
EntityStatus	状態 - アクティブまたは削除可能
TimeBoundary	時間境界の詳細をキャプチャします

AtlasClassification

分類のインスタンス。ID がありません。このオブジェクトはエンティティに関連付けられている場合にのみ存在します。

名前	型	説明
attributes		構造体の属性。
entityGuid	string	エンティティの GUID。
entityStatus	EntityStatus	エンティティの状態 - アクティブまたは削除できます。削除されたエンティティは削除されません。
lastModifiedTS	string	コンカレンシー制御の ETag。
removePropagationsOnEntityDelete	boolean	エンティティの削除時に伝達を削除するかどうかを決定します。
typeName	string	型の名前。
validityPeriods	TimeBoundary[]	有効期間を示す時間境界の配列。

AtlasErrorResponse

サービスからのエラー応答

名前	型	説明
errorCode	string	エラーコード。
errorMessage	string	エラーメッセージ。
requestId	string	要求 ID。

AtlasGlossary

用語集オブジェクト。

名前	型	説明
categories	AtlasRelatedCategoryHeader[]	カテゴリの配列。
classifications	AtlasClassification[]	分類の配列。
createTime	integer	レコードの作成時刻。
createdBy	string	レコードを作成したユーザー。
guid	string	オブジェクトの GUID。
language	string	用語集の言語。
lastModifiedTS	string	コンカレンシー制御の ETag。
longDescription	string	長いバージョンの説明。
name	string	用語集オブジェクトの名前。
qualifiedName	string	用語集オブジェクトの修飾名。
shortDescription	string	説明の短いバージョン。
terms	AtlasRelatedTermHeader[]	関連する用語ヘッダーの配列。
updateTime	integer	レコードの更新時刻。
updatedBy	string	レコードを更新したユーザー。
usage	string	用語集の使用方法。

AtlasRelatedCategoryHeader

関連するカテゴリのヘッダー。

名前	型	説明
categoryGuid	string	カテゴリの GUID。
description	string	カテゴリヘッダーの説明。
displayText	string	表示テキスト。
parentCategoryGuid	string	親カテゴリの GUID。
relationGuid	string	リレーションシップの GUID。

AtlasRelatedTermHeader

名前	型	説明
description	string	関連する用語の説明。
displayText	string	表示テキスト。
expression	string	用語の式。
relationGuid	string	リレーションシップの GUID。
status	AtlasTermRelationshipStatus	用語リレーションシップの状態。
steward	string	用語のスチュワード。
termGuid	string	用語の GUID。

AtlasTermRelationshipStatus

Atlas 用語リレーションシップの状態

名前	型	説明
ACTIVE	string	能動
DEPRECATED	string	廃止
DRAFT	string	ドラフト
OBSOLETE	string	廃れた
OTHER	string	他

EntityStatus

状態 - アクティブまたは削除可能

名前	型	説明
ACTIVE	string	状態はアクティブです。
DELETED	string	状態が削除されます。

TimeBoundary

時間境界の詳細をキャプチャします

名前	型	説明
endTime	string	時間境界の終わり。
startTime	string	時間境界の開始。
timeZone	string	時間境界のタイムゾーン。

次の方法で共有