Okr - List Key Results

服務:

Purview

API 版本:

2025-09-15-preview

列出指定目標的關鍵結果。

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

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string	Purview 統一目錄服務的端點。 範例：https://api.purview-service.microsoft.com/
objectiveId	path	True	string (uuid)	目標的唯一識別碼。
api-version	query	True	string minLength: 1	用於此作業的 API 版本。

回應

名稱	類型	Description
200 OK	PagedKeyResult	要求已成功。
Other Status Codes	Azure.Core.Foundations.ErrorResponse	未預期的錯誤回應。 標題 x-ms-error-code: string

安全性

OAuth2Auth

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
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"
    }
  ]
}

定義

名稱	Description
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	整體狀態列舉
PagedKeyResult	KeyResult 專案的分頁集合
SystemData	用於追蹤實體生命週期的系統中繼資料。

Azure.Core.Foundations.Error

Object

錯誤物件。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
details	Azure.Core.Foundations.Error[]	導致此錯誤之特定錯誤的詳細數據陣列。
innererror	Azure.Core.Foundations.InnerError	物件，包含與目前對象有關錯誤更具體的資訊。
message	string	錯誤的人類可讀取表示法。
target	string	錯誤的目標。

Azure.Core.Foundations.ErrorResponse

Object

包含錯誤詳細數據的回應。

名稱	類型	Description
error	Azure.Core.Foundations.Error	錯誤物件。

Azure.Core.Foundations.InnerError

Object

物件，包含有關錯誤的更特定資訊。 根據 Azure REST API 準則 - https://aka.ms/AzureRestApiGuidelines#handling-errors。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
innererror	Azure.Core.Foundations.InnerError	內部錯誤。

KeyResult

Object

Microsoft Purview 資料控管目錄索引鍵結果。

名稱	類型	Description
definition	string	關鍵結果的定義。
domainId	string (uuid)	網域的唯一識別碼。
goal	number (double)	關鍵結果的目標值。
id	string (uuid)	索引鍵結果的唯一識別碼。
max	number (double)	索引鍵結果的最大值。
progress	number (double)	關鍵結果的進展。
status	OverallStatusEnum	索引鍵結果的狀態。
systemData	SystemData	與索引鍵結果相關聯的系統資料。

OverallStatusEnum

列舉型別

整體狀態列舉

值	Description
NotTracked	狀態為 NotTracked。
OnTrack	狀態為 OnTrack。
Behind	狀態為「落後」。
AtRisk	狀態為 AtRisk。

PagedKeyResult

Object

KeyResult 專案的分頁集合

名稱	類型	Description
nextLink	string (uri)	專案下一頁的連結
value	KeyResult[]	此頁面上的 KeyResult 專案

SystemData

Object

用於追蹤實體生命週期的系統中繼資料。

名稱	類型	Description
createdAt	string	建立實體的時間戳記。
createdBy	string (uuid)	資產的唯一識別碼。
lastModifiedAt	string (date-time)	上次修改實體的時間戳記。
lastModifiedBy	string (uuid)	上次修改實體之使用者的唯一識別碼。