Okr - List Key Results

Serviço:

Purview

Versão API:

2025-09-15-preview

Lista os principais resultados para um determinado objetivo.

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

Parâmetros URI

Nome	Em	Necessário	Tipo	Descrição
endpoint	path	True	string	O ponto final do serviço Purview Unified Catalog. Exemplo: https://api.purview-service.microsoft.com/
objectiveId	path	True	string (uuid)	O identificador único do objetivo.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Respostas

Nome	Tipo	Descrição
200 OK	PagedKeyResult	O pedido foi bem-sucedido.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Segurança

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL de autorização: https://login.microsoftonline.com/common/oauth2/authorize

Alcances

Nome	Descrição
https://purview.azure.net/.default

Exemplos

Okr_ListKeyResults

Pedido de exemplo

HTTP

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

Resposta de exemplo

Código de estado:

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

Definições

Nome	Descrição
Azure.Core.Foundations.Error	O objeto de erro.
Azure.Core.Foundations.ErrorResponse	Uma resposta contendo detalhes do erro.
Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API REST do Azure - https://aka.ms/AzureRestApiGuidelines#handling-errors.
KeyResult	Resultado da chave do catálogo de governança de dados do Microsoft Purview.
OverallStatusEnum	OverallStatusEnum
PagedKeyResult	Coleção paginada de itens KeyResult
SystemData	Metadados do sistema para acompanhar o ciclo de vida da entidade.

Azure.Core.Foundations.Error

Objetivo

O objeto de erro.

Nome	Tipo	Descrição
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
details	Azure.Core.Foundations.Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível por humanos do erro.
target	string	O alvo do erro.

Azure.Core.Foundations.ErrorResponse

Objetivo

Uma resposta contendo detalhes do erro.

Nome	Tipo	Descrição
error	Azure.Core.Foundations.Error	O objeto de erro.

Azure.Core.Foundations.InnerError

Objetivo

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API REST do Azure - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Nome	Tipo	Descrição
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
innererror	Azure.Core.Foundations.InnerError	Erro interno.

KeyResult

Objetivo

Resultado da chave do catálogo de governança de dados do Microsoft Purview.

Nome	Tipo	Descrição
definition	string	A definição do resultado-chave.
domainId	string (uuid)	O identificador exclusivo do domínio.
goal	number (double)	O valor da meta para o resultado principal.
id	string (uuid)	O identificador exclusivo do resultado da chave.
max	number (double)	O valor máximo para o resultado da chave.
progress	number (double)	O progresso do resultado-chave.
status	OverallStatusEnum	O status do resultado principal.
systemData	SystemData	Os dados do sistema associados ao resultado-chave.

OverallStatusEnum

Enumeração

OverallStatusEnum

Valor	Descrição
NotTracked	O status é NotTracked.
OnTrack	O status é OnTrack.
Behind	O status está atrasado.
AtRisk	O status é AtRisk.

PagedKeyResult

Objetivo

Coleção paginada de itens KeyResult

Nome	Tipo	Descrição
nextLink	string (uri)	O link para a próxima página de itens
value	KeyResult[]	Os itens KeyResult nesta página

SystemData

Objetivo

Metadados do sistema para acompanhar o ciclo de vida da entidade.

Nome	Tipo	Descrição
createdAt	string	O carimbo de data/hora quando a entidade foi criada.
createdBy	string (uuid)	Identificador exclusivo do ativo.
lastModifiedAt	string (date-time)	O carimbo de data/hora quando a entidade foi modificada pela última vez.
lastModifiedBy	string (uuid)	O identificador exclusivo do usuário que modificou a entidade pela última vez.