Check Evaluations - Get

Služba:

Approvals And Checks

Verze rozhraní API:

7.1-preview.1

Získání podrobností o konkrétním vyhodnocení kontroly

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
checkSuiteId	path	True	string uuid
organization	path	True	string	Název organizace Azure DevOps.
project	path	True	string	ID projektu nebo název projektu
api-version	query	True	string	Verze rozhraní API, která se má použít. Tato verze rozhraní API by měla být nastavená na 7.1-preview.1.
$expand	query		CheckSuiteExpandParameter

Odpovědi

Name	Typ	Description
200 OK	CheckSuite	úspěšná operace

Zabezpečení

oauth2

Typ: oauth2
Tok: accessCode
URL autorizace: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL tokenu: 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

Rozsahy

Name	Description
vso.build	Uděluje možnost přístupu k artefaktům sestavení, včetně výsledků sestavení, definic a požadavků, a možnost přijímat oznámení o událostech sestavení prostřednictvím volání služeb.

Příklady

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:

200

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

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

Definice

Name	Description
CheckConfigurationRef
CheckRun
CheckRunStatus
CheckSuite
CheckSuiteExpandParameter
CheckType
JObject	Představuje objekt JSON.
ReferenceLinks	Třída představující kolekci odkazů REST.
Resource

CheckConfigurationRef

Object

Name	Typ	Description
id	integer	Zkontrolujte ID konfigurace.
resource	Resource	Prostředek, u kterého se kontrola nakonfiguruje.
type	CheckType	Kontrola typu konfigurace
url	string	Adresa URL, ze které lze načíst nakonfigurovanou kontrolu.

CheckRun

Object

Name	Typ	Description
checkConfigurationRef	CheckConfigurationRef
completedDate	string
createdDate	string
id	string
resultMessage	string
status	CheckRunStatus

CheckRunStatus

Enumeration

Hodnota	Description
all
approved
canceled
completed
failed
none
queued
rejected
running
timedOut

CheckSuite

Object

Name	Typ	Description
_links	ReferenceLinks	Odkazy.
checkRuns	CheckRun[]	Seznam spuštění kontroly přidružených k danému požadavku sady pro kontrolu
completedDate	string	Datum dokončení dané žádosti o kontrolní sadu
context	JObject	Kontext vyhodnocení pro žádost o kontrolu sady
id	string	Jedinečné ID sady vygenerované orchestrátorem kanálu pro kontrolu kanálu spustí požadavek na spuštění v seznamu prostředků Orchestrátor kanálu tento identifikátor použije k mapování požadavků na kontrolu ve fázi.
message	string	Volitelná zpráva pro danou žádost o kontrolní sadu
status	CheckRunStatus	Celkový stav spuštění kontroly pro danou žádost o sadu Toto je kontrola stavu sady.

CheckSuiteExpandParameter

Enumeration

Hodnota	Description
none
resources

CheckType

Object

Name	Typ	Description
id	string	Získá nebo nastaví ID typu kontroly.
name	string	Název typu kontroly.

JObject

Object

Představuje objekt JSON.

Name	Typ	Description
item	string
type	string	Získá typ uzlu pro tento JToken.

ReferenceLinks

Object

Třída představující kolekci odkazů REST.

Name	Typ	Description
links	object	Zobrazení odkazů jen pro čtení. Vzhledem k tomu, že odkazy jsou jen pro čtení, chceme je zveřejnit jenom jako odkazy jen pro čtení.

Resource

Object

Name	Typ	Description
id	string	ID prostředku.
name	string	Název prostředku.
type	string	Typ prostředku.