Okr - List Key Results

Služba:

Purview

Verze rozhraní API:

2025-09-15-preview

Uvádí klíčové výsledky pro daný cíl.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string	Koncový bod služby Purview Unified Catalog. Příklad: https://api.purview-service.microsoft.com/
objectiveId	path	True	string (uuid)	Jedinečný identifikátor cíle.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	PagedKeyResult	Požadavek byl úspěšný.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Neočekávaná chybová odpověď Hlavičky x-ms-error-code: string

Zabezpečení

OAuth2Auth

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

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

Příklady

Okr_ListKeyResults

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:

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

Definice

Name	Description
Azure.Core.Foundations.Error	Objekt chyby.
Azure.Core.Foundations.ErrorResponse	Odpověď obsahující podrobnosti o chybě.
Azure.Core.Foundations.InnerError	Objekt obsahující konkrétnější informace o chybě. Podle pokynů pro rozhraní Azure REST API - https://aka.ms/AzureRestApiGuidelines#handling-errors.
KeyResult	Klíčový výsledek katalogu zásad správného řízení dat Microsoft Purview.
OverallStatusEnum	Výčet celkového stavu
PagedKeyResult	Stránkovaná kolekce položek KeyResult
SystemData	Systémová metadata pro sledování životního cyklu entity.

Azure.Core.Foundations.Error

Objekt

Objekt chyby.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
details	Azure.Core.Foundations.Error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	Azure.Core.Foundations.InnerError	Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.
message	string	Čitelné znázornění chyby člověkem.
target	string	Cíl chyby.

Azure.Core.Foundations.ErrorResponse

Objekt

Odpověď obsahující podrobnosti o chybě.

Name	Typ	Description
error	Azure.Core.Foundations.Error	Objekt chyby.

Azure.Core.Foundations.InnerError

Objekt

Objekt obsahující konkrétnější informace o chybě. Podle pokynů pro rozhraní Azure REST API - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
innererror	Azure.Core.Foundations.InnerError	Vnitřní chyba.

KeyResult

Objekt

Klíčový výsledek katalogu zásad správného řízení dat Microsoft Purview.

Name	Typ	Description
definition	string	Definice klíčového výsledku.
domainId	string (uuid)	Jedinečný identifikátor domény.
goal	number (double)	Cílová hodnota klíčového výsledku.
id	string (uuid)	Jedinečný identifikátor výsledku klíče.
max	number (double)	Maximální hodnota výsledku klíče.
progress	number (double)	Průběh klíčového výsledku.
status	OverallStatusEnum	Stav klíčového výsledku.
systemData	SystemData	Systémová data spojená s klíčovým výsledkem.

OverallStatusEnum

Výčet

Výčet celkového stavu

Hodnota	Description
NotTracked	Stav je NotTracked.
OnTrack	Stav je OnTrack.
Behind	Stav je Pozad.
AtRisk	Stav je AtRisk.

PagedKeyResult

Objekt

Stránkovaná kolekce položek KeyResult

Name	Typ	Description
nextLink	string (uri)	Odkaz na další stránku položek
value	KeyResult[]	Položky KeyResult na této stránce

SystemData

Objekt

Systémová metadata pro sledování životního cyklu entity.

Name	Typ	Description
createdAt	string	Časové razítko, kdy byla entita vytvořena.
createdBy	string (uuid)	Jedinečný identifikátor datového zdroje.
lastModifiedAt	string (date-time)	Časové razítko, kdy byla entita naposledy změněna.
lastModifiedBy	string (uuid)	Jedinečný identifikátor uživatele, který naposledy změnil entitu.