Okr - List Key Results

Dienst:

Purview

API-Version:

2025-09-15-preview

Listet die wichtigsten Ergebnisse für ein bestimmtes Ziel auf.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string	Das Endpunkt des Purview Unified Catalog Service. Beispiel: https://api.purview-service.microsoft.com/
objectiveId	path	True	string (uuid)	Die eindeutige Kennung des Ziels.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	PagedKeyResult	Die Anforderung ist erfolgreich.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Unerwartete Fehlerantwort. Header x-ms-error-code: string

Sicherheit

OAuth2Auth

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
https://purview.azure.net/.default

Beispiele

Okr_ListKeyResults

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

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

Definitionen

Name	Beschreibung
Azure.Core.Foundations.Error	Das Fehlerobjekt.
Azure.Core.Foundations.ErrorResponse	Eine Antwort, die Fehlerdetails enthält.
Azure.Core.Foundations.InnerError	Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Richtlinien der Azure-REST-API: . https://aka.ms/AzureRestApiGuidelines#handling-errors
KeyResult	Wichtiges Ergebnis des Microsoft Purview Data Governance-Katalogs.
OverallStatusEnum	OverallStatusEnum
PagedKeyResult	Ausgelagerte Auflistung von KeyResult-Elementen
SystemData	Systemmetadaten zum Nachverfolgen des Lebenszyklus von Entitäten.

Azure.Core.Foundations.Error

Objekt

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
details	Azure.Core.Foundations.Error[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	Azure.Core.Foundations.InnerError	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

Azure.Core.Foundations.ErrorResponse

Objekt

Eine Antwort, die Fehlerdetails enthält.

Name	Typ	Beschreibung
error	Azure.Core.Foundations.Error	Das Fehlerobjekt.

Azure.Core.Foundations.InnerError

Objekt

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Richtlinien der Azure-REST-API: . https://aka.ms/AzureRestApiGuidelines#handling-errors

Name	Typ	Beschreibung
code	string	Eine serverdefinierte Gruppe von Fehlercodes.
innererror	Azure.Core.Foundations.InnerError	Innerer Fehler.

KeyResult

Objekt

Wichtiges Ergebnis des Microsoft Purview Data Governance-Katalogs.

Name	Typ	Beschreibung
definition	string	Die Definition des Schlüsselergebnisses.
domainId	string (uuid)	Die eindeutige Kennung der Domäne.
goal	number (double)	Der Zielwert für das Schlüsselergebnis.
id	string (uuid)	Die eindeutige Kennung des Schlüsselergebnisses.
max	number (double)	Der Maximalwert für das Schlüsselergebnis.
progress	number (double)	Der Fortschritt des Schlüsselergebnisses.
status	OverallStatusEnum	Der Status des Schlüsselergebnisses.
systemData	SystemData	Die Systemdaten, die dem Schlüsselergebnis zugeordnet sind.

OverallStatusEnum

Enumeration

OverallStatusEnum

Wert	Beschreibung
NotTracked	Der Status lautet NotTracked.
OnTrack	Der Status lautet OnTrack.
Behind	Der Status ist Rückständig.
AtRisk	Der Status lautet AtRisk.

PagedKeyResult

Objekt

Ausgelagerte Auflistung von KeyResult-Elementen

Name	Typ	Beschreibung
nextLink	string (uri)	Der Link zur nächsten Seite der Elemente
value	KeyResult[]	Die KeyResult-Elemente auf dieser Seite

SystemData

Objekt

Systemmetadaten zum Nachverfolgen des Lebenszyklus von Entitäten.

Name	Typ	Beschreibung
createdAt	string	Der Zeitstempel, zu dem die Entität erstellt wurde.
createdBy	string (uuid)	Eindeutige Kennung des Assets.
lastModifiedAt	string (date-time)	Der Zeitstempel, zu dem die Entität zuletzt geändert wurde.
lastModifiedBy	string (uuid)	Der eindeutige Bezeichner des Benutzers, der die Entität zuletzt geändert hat.