Check Evaluations - Get

Ссылка

Service:: Approvals And Checks

API Version:: 7.1-preview.1

Получение сведений для конкретной оценки проверка

GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/checks/runs/{checkSuiteId}?api-version=7.1-preview.1

With optional parameters:

GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/checks/runs/{checkSuiteId}?$expand={$expand}&api-version=7.1-preview.1

Параметры URI

Имя	В	Обязательно	Тип	Описание
checkSuiteId	path	True	string uuid
organization	path	True	string	Название организации Azure DevOps.
project	path	True	string	Идентификатор проекта или имя проекта
api-version	query	True	string	Используемая версия API. Для использования этой версии API необходимо задать значение 7.1-preview.1.
$expand	query		CheckSuiteExpandParameter

Ответы

Имя	Тип	Описание
200 OK	CheckSuite	успешная операция

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

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Имя	Описание
vso.build	Предоставляет возможность доступа к артефактам сборки, включая результаты сборки, определения и запросы, а также возможность получать уведомления о событиях сборки с помощью перехватчиков служб.

Примеры

Sample Request

HTTP

GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/checks/runs/{checkSuiteId}?api-version=7.1-preview.1

Sample Response

Status code:: 200

request-Context: appId=cid-v1:a892bfef-0287-4640-9f5e-cffc90fbcf94
access-Control-Expose-Headers: Request-Context

Response Body

{
  "status": "canceled",
  "message": "",
  "completedDate": "2020-11-19T12:59:09.6567354Z",
  "checkRuns": [
    {
      "id": "c579b5e1-9722-42e1-981e-63e004e6cb69",
      "createdDate": "2020-11-19T12:59:09.6567354Z",
      "completedDate": "2020-11-19T12:59:09.6567354Z",
      "checkConfigurationRef": {
        "id": 15,
        "type": {
          "id": "e1a1fc6c-c278-4492-ae1c-c42f8697612c",
          "name": "Authorization"
        },
        "url": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/15",
        "resource": {
          "type": "queue",
          "id": "1"
        }
      },
      "status": "canceled",
      "resultMessage": "Check aborted. This could be because the run was canceled or another check on the stage failed."
    }
  ],
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/runs"
    }
  },
  "id": "64dc0df7-f224-4b3b-a251-f67cbe9cf7a3",
  "context": {
    "PlanId": 1,
    "Pipeline.Id": 2,
    "GraphNode.Id": 3
  }
}

Определения

Имя	Описание
CheckConfigurationRef
CheckRun
CheckRunStatus
CheckSuite
CheckSuiteExpandParameter
CheckType
JObject	Представляет объект JSON.
ReferenceLinks	Класс, представляющий коллекцию ссылок REST.
Resource

CheckConfigurationRef

Имя	Тип	Описание
id	integer	Проверьте идентификатор конфигурации.
resource	Resource	Ресурс, для которого проверка настроить.
type	CheckType	Проверка типа конфигурации
url	string	URL-адрес, по которому можно получить настроенный проверка.

CheckRun

Имя	Тип	Описание
checkConfigurationRef	CheckConfigurationRef
completedDate	string
createdDate	string
id	string
resultMessage	string
status	CheckRunStatus

CheckRunStatus

Имя	Тип	Описание
all	string
approved	string
canceled	string
completed	string
failed	string
none	string
queued	string
rejected	string
running	string
timedOut	string

CheckSuite

Имя	Тип	Описание
_links	ReferenceLinks	Ссылки на справочные материалы.
checkRuns	CheckRun[]	Список запусков проверка, связанных с заданным запросом набора проверка.
completedDate	string	Дата завершения заданного запроса набора проверка
context	JObject	Контекст оценки для запроса набора проверка
id	string	Уникальный идентификатор набора, созданный оркестратором конвейера для конвейера, проверка выполняет запрос в списке ресурсов. Оркестратор конвейера будет использовать этот идентификатор для сопоставления запросов проверка на этапе
message	string	Необязательное сообщение для заданного запроса набора проверка
status	CheckRunStatus	Общее состояние выполнения проверка для заданного запроса набора. Это состояние набора проверка

CheckSuiteExpandParameter

Имя	Тип	Описание
none	string
resources	string

CheckType

Имя	Тип	Описание
id	string	Возвращает или задает идентификатор типа проверка.
name	string	Имя типа проверка.

JObject

Представляет объект JSON.

Имя	Тип	Описание
item	string
type	string	Возвращает тип узла для этого JToken.

ReferenceLinks

Класс, представляющий коллекцию ссылок REST.

Имя	Тип	Описание
links	object	Представление ссылок только для чтения. Так как ссылочные ссылки доступны только для чтения, мы хотим предоставить их только для чтения.

Resource

Имя	Тип	Описание
id	string	Идентификатор ресурса.
name	string	Имя ресурса.
type	string	Тип ресурса.

Share via