Check Evaluations - Get

Riferimento

Servizio:: Approvals And Checks

Versione API:: 7.1-preview.1

Ottenere i dettagli per una valutazione di verifica specifica

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

Con parametri facoltativi:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
checkSuiteId	path	True	string (uuid)
organization	path	True	string	Nome dell'organizzazione di Azure DevOps.
project	path	True	string	ID progetto o nome progetto
api-version	query	True	string	Versione dell'API da usare. Deve essere impostato su '7.1-preview.1' per usare questa versione dell'API.
$expand	query		CheckSuiteExpandParameter

Risposte

Nome	Tipo	Descrizione
200 OK	CheckSuite	operazione riuscita

Sicurezza

oauth2

Tipo: oauth2
Flow: accessCode
URL di autorizzazione: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL token: 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

Ambiti

Nome	Descrizione
vso.build	Concede la possibilità di accedere agli artefatti di compilazione, inclusi i risultati di compilazione, le definizioni e le richieste e la possibilità di ricevere notifiche sugli eventi di compilazione tramite hook del servizio.

Esempio

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:: 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
  }
}

Definizioni

Nome	Descrizione
CheckConfigurationRef
CheckRun
CheckRunStatus
CheckSuite
CheckSuiteExpandParameter
CheckType
JObject	Rappresenta un oggetto JSON.
ReferenceLinks	Classe per rappresentare una raccolta di collegamenti di riferimento REST.
Resource

CheckConfigurationRef

Object

Nome	Tipo	Descrizione
id	integer (int32)	Controllare l'ID di configurazione.
resource	Resource	Risorsa in cui verificare la configurazione.
type	CheckType	Controllare il tipo di configurazione
url	string	URL da cui è possibile recuperare il controllo configurato.

CheckRun

Object

Nome	Tipo	Descrizione
checkConfigurationRef	CheckConfigurationRef
completedDate	string (date-time)
createdDate	string (date-time)
id	string (uuid)
resultMessage	string
status	CheckRunStatus

CheckRunStatus

Enumerazione

Valore	Descrizione
all
approved
canceled
completed
failed
none
queued
rejected
running
timedOut

CheckSuite

Object

Nome	Tipo	Descrizione
_links	ReferenceLinks	Collegamenti di riferimento.
checkRuns	CheckRun[]	Elenco delle esecuzioni di controllo associate alla richiesta della suite di controllo specificata.
completedDate	string (date-time)	Data di completamento della richiesta del gruppo di controllo specificato
context	JObject	Contesto di valutazione per la richiesta check suite
id	string (uuid)	ID suite univoco generato dall'agente di orchestrazione della pipeline per la richiesta di esecuzione del controllo della pipeline nell'elenco di risorse L'agente di orchestrazione pipeline utilizzerà questo identificatore per eseguire il mapping delle richieste di controllo in una fase
message	string	Messaggio facoltativo per la richiesta della suite di controllo specificata
status	CheckRunStatus	Stato complessivo delle esecuzioni del controllo per la richiesta della suite specificata. Questo è il controllo dello stato della suite

CheckSuiteExpandParameter

Enumerazione

Valore	Descrizione
none
resources

CheckType

Object

Nome	Tipo	Descrizione
id	string (uuid)	Ottiene o imposta l'ID del tipo di controllo.
name	string	Nome del tipo di controllo.

JObject

Object

Rappresenta un oggetto JSON.

Nome	Tipo	Descrizione
item	string (JToken)
type	string (JTokenType)	Ottiene il tipo di nodo per questo JToken.

ReferenceLinks

Object

Classe per rappresentare una raccolta di collegamenti di riferimento REST.

Nome	Tipo	Descrizione
links	object	Visualizzazione di sola lettura dei collegamenti. Poiché i collegamenti di riferimento sono di sola lettura, è consigliabile esporli solo come di sola lettura.

Resource

Object

Nome	Tipo	Descrizione
id	string	ID della risorsa.
name	string	Nome della risorsa.
type	string	Tipo della risorsa.