Check Evaluations - Get

Odwołanie

Service:: Approvals And Checks

API Version:: 7.1-preview.1

Uzyskiwanie szczegółów dla określonej oceny sprawdzania

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
checkSuiteId	path	True	string uuid
organization	path	True	string	Nazwa organizacji usługi Azure DevOps.
project	path	True	string	Identyfikator projektu lub nazwa projektu
api-version	query	True	string	Wersja interfejsu API do użycia. Ta wartość powinna być ustawiona na wartość "7.1-preview.1", aby używać tej wersji interfejsu API.
$expand	query		CheckSuiteExpandParameter

Odpowiedzi

Nazwa	Typ	Opis
200 OK	CheckSuite	operacja zakończona powodzeniem

Zabezpieczenia

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

Nazwa	Opis
vso.build	Umożliwia dostęp do artefaktów kompilacji, w tym wyników kompilacji, definicji i żądań oraz możliwość odbierania powiadomień o zdarzeniach kompilacji za pośrednictwem punktów zaczepienia usługi.

Przykłady

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

Definicje

Nazwa	Opis
CheckConfigurationRef
CheckRun
CheckRunStatus
CheckSuite
CheckSuiteExpandParameter
CheckType
JObject	Reprezentuje obiekt JSON.
ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.
Resource

CheckConfigurationRef

Nazwa	Typ	Opis
id	integer	Sprawdź identyfikator konfiguracji.
resource	Resource	Zasób, na którym jest konfigurowana kontrola.
type	CheckType	Sprawdzanie typu konfiguracji
url	string	Adres URL, z którego można pobrać skonfigurowane sprawdzanie.

CheckRun

Nazwa	Typ	Opis
checkConfigurationRef	CheckConfigurationRef
completedDate	string
createdDate	string
id	string
resultMessage	string
status	CheckRunStatus

CheckRunStatus

Nazwa	Typ	Opis
all	string
approved	string
canceled	string
completed	string
failed	string
none	string
queued	string
rejected	string
running	string
timedOut	string

CheckSuite

Nazwa	Typ	Opis
_links	ReferenceLinks	Linki referencyjne.
checkRuns	CheckRun[]	Lista przebiegów sprawdzania skojarzonych z danym żądaniem pakietu kontrolnego.
completedDate	string	Data ukończenia danego żądania pakietu kontrolnego
context	JObject	Kontekst oceny żądania pakietu sprawdzania
id	string	Unikatowy identyfikator pakietu wygenerowany przez koordynatora potoku dla żądania uruchomienia potoku na liście zasobów Orkiestrator potoku będzie używać tego identyfikatora do mapowania żądań sprawdzania na etapie
message	string	Opcjonalny komunikat dla danego żądania pakietu kontrolnego
status	CheckRunStatus	Ogólny stan przebiegów sprawdzania dla danego żądania pakietu. To jest sprawdzanie stanu pakietu

CheckSuiteExpandParameter

Nazwa	Typ	Opis
none	string
resources	string

CheckType

Nazwa	Typ	Opis
id	string	Pobiera lub ustawia identyfikator typu sprawdzania.
name	string	Nazwa typu sprawdzania.

JObject

Reprezentuje obiekt JSON.

Nazwa	Typ	Opis
item	string
type	string	Pobiera typ węzła dla tego tokenu JToken.

ReferenceLinks

Klasa reprezentująca kolekcję linków referencyjnych REST.

Nazwa	Typ	Opis
links	object	Widok linków w trybie tylko do odczytu. Ponieważ linki odwołania są tylko do odczytu, chcemy uwidocznić je tylko jako tylko do odczytu.

Resource

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
name	string	Nazwa zasobu.
type	string	Typ zasobu.

Udostępnij za pośrednictwem