Okr - List Key Results

Service:

Purview

Version d'API:

2025-09-15-preview

Répertorie les résultats clés pour un objectif donné.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string	Le point d’arrivée du service Purview Unified Catalog. Exemple : https://api.purview-service.microsoft.com/
objectiveId	path	True	string (uuid)	L’identifiant unique de l’objectif.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
200 OK	PagedKeyResult	La demande a réussi.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Réponse d’erreur inattendue. En-têtes x-ms-error-code: string

Sécurité

OAuth2Auth

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

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

Exemples

Okr_ListKeyResults

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:

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

Définitions

Nom	Description
Azure.Core.Foundations.Error	Objet d’erreur.
Azure.Core.Foundations.ErrorResponse	Réponse contenant les détails de l’erreur.
Azure.Core.Foundations.InnerError	Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux directives de l’API REST Azure : https://aka.ms/AzureRestApiGuidelines#handling-errors.
KeyResult	Résultat clé du catalogue de gouvernance des données Microsoft Purview.
OverallStatusEnum	OverallStatusEnum
PagedKeyResult	Collection paginée d’éléments KeyResult
SystemData	Métadonnées système pour le suivi du cycle de vie des entités.

Azure.Core.Foundations.Error

Objet

Objet d’erreur.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
details	Azure.Core.Foundations.Error[]	Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée.
innererror	Azure.Core.Foundations.InnerError	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Représentation lisible par l’homme de l’erreur.
target	string	Cible de l’erreur.

Azure.Core.Foundations.ErrorResponse

Objet

Réponse contenant les détails de l’erreur.

Nom	Type	Description
error	Azure.Core.Foundations.Error	Objet d’erreur.

Azure.Core.Foundations.InnerError

Objet

Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux directives de l’API REST Azure : https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nom	Type	Description
code	string	Un ensemble de codes d’erreur définis par le serveur.
innererror	Azure.Core.Foundations.InnerError	Erreur interne.

KeyResult

Objet

Résultat clé du catalogue de gouvernance des données Microsoft Purview.

Nom	Type	Description
definition	string	La définition du résultat clé.
domainId	string (uuid)	L’identifiant unique du domaine.
goal	number (double)	Valeur de l’objectif pour le résultat clé.
id	string (uuid)	Identificateur unique du résultat de la clé.
max	number (double)	Valeur maximale du résultat de la clé.
progress	number (double)	L’avancement du résultat clé.
status	OverallStatusEnum	L’état du résultat clé.
systemData	SystemData	Données système associées au résultat clé.

OverallStatusEnum

Énumération

OverallStatusEnum

Valeur	Description
NotTracked	L’état est NotTracked.
OnTrack	Le statut est OnTrack.
Behind	Le statut est Behind.
AtRisk	Le statut est À risque.

PagedKeyResult

Objet

Collection paginée d’éléments KeyResult

Nom	Type	Description
nextLink	string (uri)	Le lien vers la page suivante des éléments
value	KeyResult[]	Les éléments KeyResult de cette page

SystemData

Objet

Métadonnées système pour le suivi du cycle de vie des entités.

Nom	Type	Description
createdAt	string	Horodatage de la création de l’entité.
createdBy	string (uuid)	Identifiant unique de l’actif.
lastModifiedAt	string (date-time)	Horodatage de la dernière modification de l’entité.
lastModifiedBy	string (uuid)	Identificateur unique de l’utilisateur qui a modifié l’entité pour la dernière fois.