Okr - List Key Results

Layanan:

Purview

Versi API:

2025-09-15-preview

Mencantumkan hasil utama untuk tujuan tertentu.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string	Titik akhir layanan Purview Unified Catalog. Contoh: https://api.purview-service.microsoft.com/
objectiveId	path	True	string (uuid)	Pengidentifikasi unik dari tujuan.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.

Respons

Nama	Jenis	Deskripsi
200 OK	PagedKeyResult	Permintaan telah berhasil.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Respons kesalahan tak terduga. Header x-ms-error-code: string

Keamanan

OAuth2Auth

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
https://purview.azure.net/.default

Contoh

Okr_ListKeyResults

Permintaan sampel

HTTP

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

Respon sampel

Kode status:

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"
    }
  ]
}

Definisi

Nama	Deskripsi
Azure.Core.Foundations.Error	Objek kesalahan.
Azure.Core.Foundations.ErrorResponse	Respons yang berisi detail kesalahan.
Azure.Core.Foundations.InnerError	Objek yang berisi informasi yang lebih spesifik tentang kesalahan. Sesuai pedoman Azure REST API - https://aka.ms/AzureRestApiGuidelines#handling-errors.
KeyResult	Hasil Kunci Katalog Tata Kelola Data Microsoft Purview.
OverallStatusEnum	KeseluruhanStatusEnum
PagedKeyResult	Kumpulan halaman item KeyResult
SystemData	Metadata sistem untuk melacak siklus hidup entitas.

Azure.Core.Foundations.Error

Objek

Objek kesalahan.

Nama	Jenis	Deskripsi
code	string	Salah satu sekumpulan kode kesalahan yang ditentukan server.
details	Azure.Core.Foundations.Error[]	Array detail tentang kesalahan tertentu yang menyebabkan kesalahan yang dilaporkan ini.
innererror	Azure.Core.Foundations.InnerError	Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.
message	string	Representasi kesalahan yang dapat dibaca manusia.
target	string	Target kesalahan.

Azure.Core.Foundations.ErrorResponse

Objek

Respons yang berisi detail kesalahan.

Nama	Jenis	Deskripsi
error	Azure.Core.Foundations.Error	Objek kesalahan.

Azure.Core.Foundations.InnerError

Objek

Objek yang berisi informasi yang lebih spesifik tentang kesalahan. Sesuai pedoman Azure REST API - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nama	Jenis	Deskripsi
code	string	Salah satu sekumpulan kode kesalahan yang ditentukan server.
innererror	Azure.Core.Foundations.InnerError	Kesalahan dalam.

KeyResult

Objek

Hasil Kunci Katalog Tata Kelola Data Microsoft Purview.

Nama	Jenis	Deskripsi
definition	string	Definisi hasil kunci.
domainId	string (uuid)	Pengidentifikasi unik domain.
goal	number (double)	Nilai tujuan untuk hasil utama.
id	string (uuid)	Pengidentifikasi unik dari hasil kunci.
max	number (double)	Nilai maksimum untuk hasil kunci.
progress	number (double)	Kemajuan hasil kunci.
status	OverallStatusEnum	Status hasil kunci.
systemData	SystemData	Data sistem yang terkait dengan hasil utama.

OverallStatusEnum

Enumerasi

KeseluruhanStatusEnum

Nilai	Deskripsi
NotTracked	Statusnya adalah NotTracked.
OnTrack	Statusnya adalah OnTrack.
Behind	Statusnya Behind.
AtRisk	Statusnya adalah AtRisk.

PagedKeyResult

Objek

Kumpulan halaman item KeyResult

Nama	Jenis	Deskripsi
nextLink	string (uri)	Tautan ke halaman item berikutnya
value	KeyResult[]	Item KeyResult di halaman ini

SystemData

Objek

Metadata sistem untuk melacak siklus hidup entitas.

Nama	Jenis	Deskripsi
createdAt	string	Stempel waktu saat entitas dibuat.
createdBy	string (uuid)	Pengidentifikasi unik aset.
lastModifiedAt	string (date-time)	Stempel waktu saat entitas terakhir diubah.
lastModifiedBy	string (uuid)	Pengidentifikasi unik pengguna yang terakhir memodifikasi entitas.