Okr - List Key Results

Servicio:

Purview

Versión de la API:

2025-09-15-preview

Enumera los resultados clave para un objetivo determinado.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string	El punto final del servicio Purview Unified Catalog. Ejemplo: https://api.purview-service.microsoft.com/
objectiveId	path	True	string (uuid)	El identificador único del objetivo.
api-version	query	True	string minLength: 1	Versión de API que se usará para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	PagedKeyResult	La solicitud se ha realizado correctamente.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Una respuesta de error inesperada. Encabezados x-ms-error-code: string

Seguridad

OAuth2Auth

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

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

Ejemplos

Okr_ListKeyResults

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:

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

Definiciones

Nombre	Description
Azure.Core.Foundations.Error	Objeto de error.
Azure.Core.Foundations.ErrorResponse	Respuesta que contiene los detalles del error.
Azure.Core.Foundations.InnerError	Objeto que contiene información más específica sobre el error. Según las directrices de la API de REST de Azure: https://aka.ms/AzureRestApiGuidelines#handling-errors.
KeyResult	Resultado clave del catálogo de gobernanza de datos de Microsoft Purview.
OverallStatusEnum	Enumeración de estado general
PagedKeyResult	Colección paginada de elementos KeyResult
SystemData	Metadatos del sistema para realizar un seguimiento del ciclo de vida de la entidad.

Azure.Core.Foundations.Error

Objeto

Objeto de error.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
details	Azure.Core.Foundations.Error[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror	Azure.Core.Foundations.InnerError	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Representación legible del error.
target	string	Destino del error.

Azure.Core.Foundations.ErrorResponse

Objeto

Respuesta que contiene los detalles del error.

Nombre	Tipo	Description
error	Azure.Core.Foundations.Error	Objeto de error.

Azure.Core.Foundations.InnerError

Objeto

Objeto que contiene información más específica sobre el error. Según las directrices de la API de REST de Azure: https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
innererror	Azure.Core.Foundations.InnerError	Error interno.

KeyResult

Objeto

Resultado clave del catálogo de gobernanza de datos de Microsoft Purview.

Nombre	Tipo	Description
definition	string	La definición del resultado clave.
domainId	string (uuid)	El identificador único del dominio.
goal	number (double)	El valor objetivo para el resultado clave.
id	string (uuid)	Identificador único del resultado clave.
max	number (double)	El valor máximo para el resultado clave.
progress	number (double)	El progreso del resultado clave.
status	OverallStatusEnum	El estado del resultado clave.
systemData	SystemData	Los datos del sistema asociados con el resultado clave.

OverallStatusEnum

Enumeración

Enumeración de estado general

Valor	Description
NotTracked	El estado es NotTracked.
OnTrack	El estado es OnTrack.
Behind	El estado es Detrás.
AtRisk	El estado es AtRisk.

PagedKeyResult

Objeto

Colección paginada de elementos KeyResult

Nombre	Tipo	Description
nextLink	string (uri)	El enlace a la siguiente página de artículos
value	KeyResult[]	Los elementos KeyResult de esta página

SystemData

Objeto

Metadatos del sistema para realizar un seguimiento del ciclo de vida de la entidad.

Nombre	Tipo	Description
createdAt	string	La marca de tiempo en la que se creó la entidad.
createdBy	string (uuid)	Identificador único del activo.
lastModifiedAt	string (date-time)	La marca de tiempo en la que se modificó por última vez la entidad.
lastModifiedBy	string (uuid)	Identificador único del usuario que modificó la entidad por última vez.