Okr - List Key Results

Служба:

Purview

Версия API:

2025-09-15-preview

Перечисляет ключевые результаты для заданной цели.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string	Конечная точка сервиса Purview Unified Catalog. Пример: https://api.purview-service.microsoft.com/
objectiveId	path	True	string (uuid)	Уникальный идентификатор цели.
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

Ответы

Имя	Тип	Описание
200 OK	PagedKeyResult	Запрос выполнен успешно.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Непредвиденное сообщение об ошибке. Заголовки x-ms-error-code: string

Безопасность

OAuth2Auth

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
https://purview.azure.net/.default

Примеры

Okr_ListKeyResults

Образец запроса

HTTP

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

Пример ответа

Код состояния:

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

Определения

Имя	Описание
Azure.Core.Foundations.Error	Объект ошибки.
Azure.Core.Foundations.ErrorResponse	Ответ, содержащий сведения об ошибке.
Azure.Core.Foundations.InnerError	Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по Azure REST API — https://aka.ms/AzureRestApiGuidelines#handling-errors.
KeyResult	Ключевой результат каталога управления данными Microsoft Purview.
OverallStatusEnum	OverallStatusEnum (OverallStatusEnum)
PagedKeyResult	Выгружаемая коллекция элементов KeyResult
SystemData	Системные метаданные для отслеживания жизненного цикла сущности.

Azure.Core.Foundations.Error

Объект

Объект ошибки.

Имя	Тип	Описание
code	string	Один из определяемых сервером кодов ошибок.
details	Azure.Core.Foundations.Error[]	Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке.
innererror	Azure.Core.Foundations.InnerError	Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.
message	string	Читаемое пользователем представление ошибки.
target	string	Целевой объект ошибки.

Azure.Core.Foundations.ErrorResponse

Объект

Ответ, содержащий сведения об ошибке.

Имя	Тип	Описание
error	Azure.Core.Foundations.Error	Объект ошибки.

Azure.Core.Foundations.InnerError

Объект

Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по Azure REST API — https://aka.ms/AzureRestApiGuidelines#handling-errors.

Имя	Тип	Описание
code	string	Один из определяемых сервером кодов ошибок.
innererror	Azure.Core.Foundations.InnerError	Внутренняя ошибка.

KeyResult

Объект

Ключевой результат каталога управления данными Microsoft Purview.

Имя	Тип	Описание
definition	string	Определение ключевого результата.
domainId	string (uuid)	Уникальный идентификатор домена.
goal	number (double)	Целевое значение для ключевого результата.
id	string (uuid)	Уникальный идентификатор ключевого результата.
max	number (double)	Максимальное значение для ключевого результата.
progress	number (double)	Прогресс ключевого результата.
status	OverallStatusEnum	Статус ключевого результата.
systemData	SystemData	Системные данные, связанные с ключевым результатом.

OverallStatusEnum

Перечисление

OverallStatusEnum (OverallStatusEnum)

Значение	Описание
NotTracked	Статус — NotTracked.
OnTrack	Статус — OnTrack.
Behind	Статус — Отстал.
AtRisk	Статус — AtRisk.

PagedKeyResult

Объект

Выгружаемая коллекция элементов KeyResult

Имя	Тип	Описание
nextLink	string (uri)	Ссылка на следующую страницу элементов
value	KeyResult[]	Элементы KeyResult на этой странице

SystemData

Объект

Системные метаданные для отслеживания жизненного цикла сущности.

Имя	Тип	Описание
createdAt	string	Временная метка при создании сущности.
createdBy	string (uuid)	Уникальный идентификатор актива.
lastModifiedAt	string (date-time)	Временная метка последнего изменения сущности.
lastModifiedBy	string (uuid)	Уникальный идентификатор пользователя, который последним изменил сущность.