Okr - List Key Results

サービス:

Purview

API バージョン:

2025-09-15-preview

特定の目標の主な結果を一覧表示します。

GET {endpoint}/datagovernance/catalog/objectives/{objectiveId}/keyResults?api-version=2025-09-15-preview

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string	Purview 統一カタログサービスのエンドポイントです。 例: https://api.purview-service.microsoft.com/
objectiveId	path	True	string (uuid)	目的の一意の識別子。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	PagedKeyResult	要求は成功しました。
Other Status Codes	Azure.Core.Foundations.ErrorResponse	予期しないエラー応答。 ヘッダー x-ms-error-code: string

セキュリティ

OAuth2Auth

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

スコープ

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

例

Okr_ListKeyResults

要求のサンプル

HTTP

GET {endpoint}/datagovernance/catalog/objectives/4e74f902-62f5-49f4-8258-92ed2b8537ba/keyResults?api-version=2025-09-15-preview

応答のサンプル

状態コード:

200

{
  "value": [
    {
      "systemData": {
        "lastModifiedAt": "1970-01-01T00:00:00.000Z",
        "lastModifiedBy": "766BF2B9-5D8A-4FB1-B8D5-D30A53E22A9E",
        "createdAt": "1970-01-01T00:00:00.000Z",
        "createdBy": "766BF2B9-5D8A-4FB1-B8D5-D30A53E22A9E"
      },
      "id": "4e74f902-62f5-49f4-8258-92ed2b8537ba",
      "definition": "This is my key result",
      "domainId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "progress": 50,
      "goal": 100,
      "max": 100,
      "status": "NotTracked"
    }
  ]
}

定義

名前	説明
Azure.Core.Foundations.Error	エラー オブジェクト。
Azure.Core.Foundations.ErrorResponse	エラーの詳細を含む応答。
Azure.Core.Foundations.InnerError	エラーに関するより具体的な情報を含むオブジェクト。 Azure REST API ガイドライン - https://aka.ms/AzureRestApiGuidelines#handling-errorsに準拠。
KeyResult	Microsoft Purview データ ガバナンス カタログのキー結果。
OverallStatusEnum	OverallStatusEnum (全体ステータス列挙型)
PagedKeyResult	KeyResult 項目のページ コレクション
SystemData	エンティティのライフサイクルを追跡するためのシステムメタデータ。

Azure.Core.Foundations.Error

Object

エラー オブジェクト。

名前	型	説明
code	string	サーバー定義の一連のエラー コードの 1 つ。
details	Azure.Core.Foundations.Error[]	この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
innererror	Azure.Core.Foundations.InnerError	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
message	string	エラーの人間が判読できる表現。
target	string	エラーのターゲット。

Azure.Core.Foundations.ErrorResponse

Object

エラーの詳細を含む応答。

名前	型	説明
error	Azure.Core.Foundations.Error	エラー オブジェクト。

Azure.Core.Foundations.InnerError

Object

エラーに関するより具体的な情報を含むオブジェクト。 Azure REST API ガイドライン - https://aka.ms/AzureRestApiGuidelines#handling-errorsに準拠。

名前	型	説明
code	string	サーバー定義の一連のエラー コードの 1 つ。
innererror	Azure.Core.Foundations.InnerError	内部エラー。

KeyResult

Object

Microsoft Purview データ ガバナンス カタログのキー結果。

名前	型	説明
definition	string	キー結果の定義。
domainId	string (uuid)	ドメインの一意の識別子。
goal	number (double)	キー結果の目標値。
id	string (uuid)	キー結果の一意の識別子。
max	number (double)	キー結果の最大値。
progress	number (double)	主要な結果の進行状況。
status	OverallStatusEnum	キー結果のステータス。
systemData	SystemData	キー結果に関連付けられたシステム・データ。

OverallStatusEnum

列挙

OverallStatusEnum (全体ステータス列挙型)

値	説明
NotTracked	状態は NotTracked です。
OnTrack	ステータスは OnTrack です。
Behind	ステータスは [Behind] です。
AtRisk	ステータスは AtRisk です。

PagedKeyResult

Object

KeyResult 項目のページ コレクション

名前	型	説明
nextLink	string (uri)	アイテムの次のページへのリンク
value	KeyResult[]	このページの KeyResult 項目

SystemData

Object

エンティティのライフサイクルを追跡するためのシステムメタデータ。

名前	型	説明
createdAt	string	エンティティが作成されたときのタイムスタンプ。
createdBy	string (uuid)	アセットの一意の識別子。
lastModifiedAt	string (date-time)	エンティティが最後に変更されたときのタイムスタンプ。
lastModifiedBy	string (uuid)	エンティティを最後に変更したユーザーの一意の識別子。