Okr - List Key Results

Servizio:

Purview

Versione API:

2025-09-15-preview

Elenca i risultati chiave per un determinato obiettivo.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string	Il punto finale del servizio Catalogo Unificato di Purview. Esempio: https://api.purview-service.microsoft.com/
objectiveId	path	True	string (uuid)	L'identificatore univoco dell'obiettivo.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	PagedKeyResult	La richiesta ha avuto esito positivo.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Risposta di errore imprevista. Intestazioni x-ms-error-code: string

Sicurezza

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
https://purview.azure.net/.default

Esempio

Okr_ListKeyResults

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:

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

Definizioni

Nome	Descrizione
Azure.Core.Foundations.Error	Oggetto error.
Azure.Core.Foundations.ErrorResponse	Risposta contenente i dettagli dell'errore.
Azure.Core.Foundations.InnerError	Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API REST di Azure - https://aka.ms/AzureRestApiGuidelines#handling-errors.
KeyResult	Risultato chiave del catalogo della governance dei dati di Microsoft Purview.
OverallStatusEnum	OverallStatusEnum
PagedKeyResult	Raccolta di paging di elementi KeyResult
SystemData	Metadati di sistema per il monitoraggio del ciclo di vita dell'entità.

Azure.Core.Foundations.Error

Oggetto

Oggetto error.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
details	Azure.Core.Foundations.Error[]	Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
innererror	Azure.Core.Foundations.InnerError	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore.

Azure.Core.Foundations.ErrorResponse

Oggetto

Risposta contenente i dettagli dell'errore.

Nome	Tipo	Descrizione
error	Azure.Core.Foundations.Error	Oggetto error.

Azure.Core.Foundations.InnerError

Oggetto

Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API REST di Azure - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nome	Tipo	Descrizione
code	string	Uno di un set definito dal server di codici di errore.
innererror	Azure.Core.Foundations.InnerError	Errore interno.

KeyResult

Oggetto

Risultato chiave del catalogo della governance dei dati di Microsoft Purview.

Nome	Tipo	Descrizione
definition	string	La definizione del risultato chiave.
domainId	string (uuid)	L'identificatore univoco del dominio.
goal	number (double)	Il valore dell'obiettivo per il risultato chiave.
id	string (uuid)	Identificatore univoco del risultato chiave.
max	number (double)	Valore massimo per il risultato chiave.
progress	number (double)	L'andamento del risultato chiave.
status	OverallStatusEnum	Stato del risultato chiave.
systemData	SystemData	I dati di sistema associati al risultato chiave.

OverallStatusEnum

Enumerazione

OverallStatusEnum

Valore	Descrizione
NotTracked	Lo stato è NotTracked.
OnTrack	Lo stato è OnTrack.
Behind	Lo stato è Dietro.
AtRisk	Lo stato è AtRisk.

PagedKeyResult

Oggetto

Raccolta di paging di elementi KeyResult

Nome	Tipo	Descrizione
nextLink	string (uri)	Il link alla pagina successiva degli elementi
value	KeyResult[]	Elementi KeyResult in questa pagina

SystemData

Oggetto

Metadati di sistema per il monitoraggio del ciclo di vita dell'entità.

Nome	Tipo	Descrizione
createdAt	string	Timestamp in cui è stata creata l'entità.
createdBy	string (uuid)	Identificatore univoco dell'asset.
lastModifiedAt	string (date-time)	Il timestamp dell'ultima modifica dell'entità.
lastModifiedBy	string (uuid)	L'identificatore univoco dell'utente che ha modificato l'entità per ultimo.