Okr - List Key Results

Usługa:

Purview

Wersja API:

2025-09-15-preview

Wyświetla listę kluczowych wyników dla danego celu.

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

Parametry URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string	Punkt końcowy usługi Purview Unified Catalog. Przykład: https://api.purview-service.microsoft.com/
objectiveId	path	True	string (uuid)	Niepowtarzalny identyfikator celu.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	PagedKeyResult	Żądanie zakończyło się pomyślnie.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Nieoczekiwana odpowiedź na błąd. Nagłówki x-ms-error-code: string

Zabezpieczenia

OAuth2Auth

Typ: oauth2
Flow: implicit
URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresów

Nazwa	Opis
https://purview.azure.net/.default

Przykłady

Okr_ListKeyResults

Przykładowa prośba

HTTP

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

Przykładowa odpowiedź

Kod statusu:

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

Definicje

Nazwa	Opis
Azure.Core.Foundations.Error	Obiekt błędu.
Azure.Core.Foundations.ErrorResponse	Odpowiedź zawierająca szczegóły błędu.
Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu API REST platformy Azure — https://aka.ms/AzureRestApiGuidelines#handling-errors.
KeyResult	Kluczowy wynik wykazu ładu danych w Microsoft Purview.
OverallStatusEnum	OverallStatusEnum
PagedKeyResult	Stronicowana kolekcja elementów KeyResult
SystemData	Metadane systemowe do śledzenia cyklu życia encji.

Azure.Core.Foundations.Error

Sprzeciwiać się

Obiekt błędu.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Azure.Core.Foundations.Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	Azure.Core.Foundations.InnerError	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

Azure.Core.Foundations.ErrorResponse

Sprzeciwiać się

Odpowiedź zawierająca szczegóły błędu.

Nazwa	Typ	Opis
error	Azure.Core.Foundations.Error	Obiekt błędu.

Azure.Core.Foundations.InnerError

Sprzeciwiać się

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu API REST platformy Azure — https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
innererror	Azure.Core.Foundations.InnerError	Błąd wewnętrzny.

KeyResult

Sprzeciwiać się

Kluczowy wynik wykazu ładu danych w Microsoft Purview.

Nazwa	Typ	Opis
definition	string	Definicja kluczowego wyniku.
domainId	string (uuid)	Unikatowy identyfikator domeny.
goal	number (double)	Wartość celu dla kluczowego wyniku.
id	string (uuid)	Niepowtarzalny identyfikator kluczowego wyniku.
max	number (double)	Maksymalna wartość kluczowego wyniku.
progress	number (double)	Postęp w realizacji kluczowego wyniku.
status	OverallStatusEnum	Stan kluczowego wyniku.
systemData	SystemData	Dane systemowe skojarzone z kluczowym wynikiem.

OverallStatusEnum

Wyliczenie

OverallStatusEnum

Wartość	Opis
NotTracked	Stan to NotTracked.
OnTrack	Stan to OnTrack.
Behind	Stan to Behind.
AtRisk	Stan to Zagrożony.

PagedKeyResult

Sprzeciwiać się

Stronicowana kolekcja elementów KeyResult

Nazwa	Typ	Opis
nextLink	string (uri)	Link do następnej strony elementów
value	KeyResult[]	Elementy KeyResult na tej stronie

SystemData

Sprzeciwiać się

Metadane systemowe do śledzenia cyklu życia encji.

Nazwa	Typ	Opis
createdAt	string	Sygnatura czasowa, kiedy jednostka została utworzona.
createdBy	string (uuid)	Niepowtarzalny identyfikator składnika aktywów.
lastModifiedAt	string (date-time)	Sygnatura czasowa ostatniej modyfikacji jednostki.
lastModifiedBy	string (uuid)	Unikatowy identyfikator użytkownika, który jako ostatni zmodyfikował jednostkę.