Glossary - Get Term

リファレンス

サービス:: Purview

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

GUID で特定の用語集の用語を取得します。

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

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

GET {endpoint}/datamap/api/atlas/v2/glossary/term/{termId}?api-version=2023-09-01

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string
termId	path	True	string	用語集の用語のグローバル一意識別子。
api-version	query		string	この操作に使用する API バージョン。

応答

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

セキュリティ

OAuth2Auth

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

スコープ

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

例

Glossary_GetTerm

Glossary_GetTermWithoutAssets

Glossary_GetTerm

要求のサンプル

HTTP

GET {endpoint}/datamap/api/atlas/v2/glossary/term/54688d39-b298-4104-9e80-f2a16f44aaea?api-version=2023-09-01

応答のサンプル

状態コード:: 200

{
  "guid": "54688d39-b298-4104-9e80-f2a16f44aaea",
  "qualifiedName": "ExampleTerm1@Glossary",
  "name": "ExampleTerm1",
  "shortDescription": "Example Short Description",
  "lastModifiedTS": "1",
  "abbreviation": "T1",
  "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
  "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
  "createTime": 1606287247276,
  "updateTime": 1606287247276,
  "status": "Approved",
  "anchor": {
    "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
    "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0"
  },
  "seeAlso": [
    {
      "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008",
      "relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01",
      "displayText": "ExampleTerm2"
    }
  ],
  "synonyms": [
    {
      "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008",
      "relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c",
      "displayText": "ExampleTerm2"
    }
  ],
  "contacts": {
    "Expert": [
      {
        "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
        "info": "Example Expert Info"
      }
    ],
    "Steward": [
      {
        "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
        "info": "Example Steward Info"
      }
    ]
  },
  "resources": [
    {
      "displayName": "Example Display Name",
      "url": "Example Url"
    }
  ],
  "assignedEntities": [
    {
      "guid": "7e255139-b654-4c8d-a4bd-fbb5a243e83f",
      "typeName": "azure_datalake_gen2_path",
      "entityStatus": "ACTIVE",
      "displayText": "moviesDB.csv",
      "relationshipType": "AtlasGlossarySemanticAssignment",
      "relationshipGuid": "ace36560-6259-4e7f-9214-3850b2af0a86",
      "relationshipStatus": "ACTIVE",
      "relationshipAttributes": {
        "typeName": "AtlasGlossarySemanticAssignment",
        "attributes": {
          "expression": null,
          "createdBy": null,
          "steward": null,
          "confidence": null,
          "description": null,
          "source": null,
          "status": null
        }
      }
    }
  ]
}

Glossary_GetTermWithoutAssets

要求のサンプル

HTTP

GET {endpoint}/datamap/api/atlas/v2/glossary/term/54688d39-b298-4104-9e80-f2a16f44aaea?api-version=2023-09-01

応答のサンプル

状態コード:: 200

{
  "guid": "54688d39-b298-4104-9e80-f2a16f44aaea",
  "qualifiedName": "ExampleTerm1@Glossary",
  "name": "ExampleTerm1",
  "shortDescription": "Example Short Description",
  "lastModifiedTS": "1",
  "abbreviation": "T1",
  "createdBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
  "updatedBy": "23863cef-a2e9-40a3-a427-44dc0d201f61",
  "createTime": 1606287247276,
  "updateTime": 1606287247276,
  "status": "Approved",
  "anchor": {
    "glossaryGuid": "c018ddaf-7c21-4b37-a838-dae5f110c3d8",
    "relationGuid": "7b6a8149-a928-476a-a068-dce58653cfa0"
  },
  "seeAlso": [
    {
      "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008",
      "relationGuid": "dfa44030-bd14-4111-a0f1-3d01c964eb01",
      "displayText": "ExampleTerm2"
    }
  ],
  "synonyms": [
    {
      "termGuid": "952c7ba4-4c89-42d8-a05a-7d2161be7008",
      "relationGuid": "15bcbd12-eb48-4b63-8ff5-74f7ec3a562c",
      "displayText": "ExampleTerm2"
    }
  ],
  "contacts": {
    "Expert": [
      {
        "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
        "info": "Example Expert Info"
      }
    ],
    "Steward": [
      {
        "id": "30435ff9-9b96-44af-a5a9-e05c8b1ae2df",
        "info": "Example Steward Info"
      }
    ]
  },
  "resources": [
    {
      "displayName": "Example Display Name",
      "url": "Example Url"
    }
  ]
}

定義

名前	説明
AtlasClassification	分類のインスタンス。ID がありません。このオブジェクトはエンティティに関連付けられている場合にのみ存在します。
AtlasErrorResponse	サービスからのエラー応答
AtlasGlossaryHeader	基本情報を含む用語集のヘッダー。
AtlasGlossaryTerm	用語集の用語。
AtlasRelatedObjectId	リレーションシップ属性値で使用される AtlasEntity 型のオブジェクトインスタンスへの参照
AtlasRelatedTermHeader	関連する用語のヘッダー。
AtlasStruct	構造体の内容の詳細をキャプチャします。直接インスタンス化されず、AtlasEntity、AtlasClassification 経由でのみ使用されます。
AtlasTermCategorizationHeader	用語分類の基本情報。
AtlasTermRelationshipStatus	Atlas 用語リレーションシップの状態
EntityStatus	状態 - アクティブまたは削除可能
PurviewObjectId	PurviewObjectId
ResourceLink	ResourceLink
StatusAtlasRelationship	Atlas リレーションシップの状態
TermStatus	用語の状態
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 です。

AtlasGlossaryHeader

基本情報を含む用語集のヘッダー。

名前	型	説明
displayText	string	表示テキスト。
glossaryGuid	string	用語集の GUID。
relationGuid	string	リレーションシップの GUID。

AtlasGlossaryTerm

用語集の用語。

名前	型	説明
abbreviation	string	用語の省略形。
anchor	AtlasGlossaryHeader	基本情報を含む用語集のヘッダー。
antonyms	AtlasRelatedTermHeader[]	関連する用語ヘッダーの配列をアントニムとして指定します。
assignedEntities	AtlasRelatedObjectId[]	関連するオブジェクト ID の配列。
attributes	object	用語のカスタム属性。マップ文字列、マップ<<文字列、オブジェクト>>です。最初のレイヤーマップのキーは、用語テンプレート名です。
categories	AtlasTermCategorizationHeader[]	用語分類ヘッダーの配列。
classifications	AtlasClassification[]	分類の配列。
classifies	AtlasRelatedTermHeader[]	関連する用語ヘッダーの配列。
contacts	object	用語の連絡先の辞書。キーには、Expert または Steward を指定できます。
createTime	integer	レコードの作成時刻。
createdBy	string	レコードを作成したユーザー。
examples	string[]	例の配列。
guid	string	オブジェクトの GUID。
hierarchyInfo	PurviewObjectId[]	用語の階層情報。
isA	AtlasRelatedTermHeader[]	is-a リレーションシップを示す関連用語ヘッダーの配列。
lastModifiedTS	string	コンカレンシー制御の ETag。
longDescription	string	長いバージョンの説明。
name	string	用語集オブジェクトの名前。
nickName	string	用語のニック名。
preferredTerms	AtlasRelatedTermHeader[]	推奨される関連用語ヘッダーの配列。
preferredToTerms	AtlasRelatedTermHeader[]	推奨される関連用語ヘッダーの配列。
qualifiedName	string	用語集オブジェクトの修飾名。
replacedBy	AtlasRelatedTermHeader[]	で置き換えられる関連用語ヘッダーの配列。
replacementTerms	AtlasRelatedTermHeader[]	置換用の関連用語ヘッダーの配列。
resources	ResourceLink[]	用語のリソースリンクの配列
seeAlso	AtlasRelatedTermHeader[]	関連する用語ヘッダーの配列も参照してください。
shortDescription	string	説明の短いバージョン。
status	TermStatus	AtlasGlossaryTerm の状態
synonyms	AtlasRelatedTermHeader[]	シノニムとしての関連用語ヘッダーの配列。
templateName	TemplateName[]	テンプレートの名前。
translatedTerms	AtlasRelatedTermHeader[]	翻訳された関連用語ヘッダーの配列。
translationTerms	AtlasRelatedTermHeader[]	翻訳に関連する用語ヘッダーの配列。
updateTime	integer	レコードの更新時刻。
updatedBy	string	レコードを更新したユーザー。
usage	string	用語の使用法。
validValues	AtlasRelatedTermHeader[]	有効な値として関連する用語ヘッダーの配列。
validValuesFor	AtlasRelatedTermHeader[]	他のレコードの有効な値として、関連する用語ヘッダーの配列。

AtlasRelatedObjectId

リレーションシップ属性値で使用される AtlasEntity 型のオブジェクトインスタンスへの参照

名前	型	説明
displayText	string	表示テキスト。
entityStatus	EntityStatus	エンティティの状態 - アクティブまたは削除できます。削除されたエンティティは削除されません。
guid	string	オブジェクトの GUID。
relationshipAttributes	AtlasStruct	構造体の内容の詳細をキャプチャします。直接インスタンス化されません。AtlasEntity、AtlasClassification 経由でのみ使用されます。
relationshipGuid	string	リレーションシップの GUID。
relationshipStatus	StatusAtlasRelationship	リレーションシップの状態の列挙型。
relationshipType	string	リレーションシップの種類
typeName	string	型の名前。
uniqueAttributes		オブジェクトの一意の属性。

AtlasRelatedTermHeader

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

AtlasStruct

構造体の内容の詳細をキャプチャします。直接インスタンス化されず、AtlasEntity、AtlasClassification 経由でのみ使用されます。

名前	型	説明
attributes		構造体の属性。
lastModifiedTS	string	コンカレンシー制御の ETag。
typeName	string	型の名前。

AtlasTermCategorizationHeader

用語分類の基本情報。

名前	型	説明
categoryGuid	string	カテゴリの GUID。
description	string	レコードの説明。
displayText	string	表示テキスト。
relationGuid	string	リレーションシップの GUID。
status	AtlasTermRelationshipStatus	用語リレーションシップの状態。

AtlasTermRelationshipStatus

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

名前	型	説明
ACTIVE	string	active
DEPRECATED	string	deprecated
DRAFT	string	ドラフト
OBSOLETE	string	廃止
OTHER	string	other

EntityStatus

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

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

PurviewObjectId

名前	型	説明
displayText	string	表示テキスト
guid	string	オブジェクトの GUID。
itemPath	string	項目のパス
name	string	名前
properties		辞書
resourceId	string	リソース ID
typeName	string	型の名前。
uniqueAttributes		オブジェクトの一意の属性。

ResourceLink

名前	型	説明
displayName	string	URL の表示名。
url	string	Web URL。 http または https

StatusAtlasRelationship

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

名前	型	説明
ACTIVE	string	active
DELETED	string	deleted

TermStatus

用語の状態

名前	型	説明
Alert	string	アラート
Approved	string	承認
Draft	string	ドラフト
Expired	string	expired

TimeBoundary

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

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

次の方法で共有

Glossary - Get Term

URI パラメーター

応答

セキュリティ

OAuth2Auth

スコープ

例

Glossary_GetTerm

要求のサンプル

応答のサンプル

Glossary_GetTermWithoutAssets

要求のサンプル

応答のサンプル

定義

AtlasClassification

AtlasErrorResponse

AtlasGlossaryHeader

AtlasGlossaryTerm

AtlasRelatedObjectId

AtlasRelatedTermHeader

AtlasStruct

AtlasTermCategorizationHeader

AtlasTermRelationshipStatus

EntityStatus

PurviewObjectId

ResourceLink

StatusAtlasRelationship

TermStatus

TimeBoundary

その他のリソース