Check Evaluations - Evaluate

Reference

Service:: Approvals And Checks

API Version:: 7.1-preview.1

Initiate an evaluation for a check in a pipeline

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

With optional parameters:

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

URI Parameters

Name	In	Required	Type	Description
organization	path	True	string	The name of the Azure DevOps organization.
project	path	True	string	Project ID or project name
api-version	query	True	string	Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.
$expand	query		CheckSuiteExpandParameter

Request Body

Name	Type	Description
context	JObject	Represents a JSON object.
id	string
resources	Resource[]

Responses

Name	Type	Description
200 OK	CheckSuite	successful operation

Security

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

Name	Description
vso.build_execute	Grants the ability to access build artifacts, including build results, definitions, and requests, and the ability to queue a build, update build properties, and the ability to receive notifications about build events via service hooks.

Examples

Sample request

HTTP

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

{
  "id": "64dc0df7-f224-4b3b-a251-f67cbe9cf7a3",
  "resources": [
    {
      "type": "queue",
      "id": "1",
      "name": "Default"
    }
  ],
  "context": {
    "PlanId": 1,
    "Pipeline.Id": 2,
    "GraphNode.Id": 3
  }
}

Sample response

Status code:: 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
  }
}

Definitions

Name	Description
CheckConfigurationRef
CheckRun
CheckRunStatus
CheckSuite
CheckSuiteExpandParameter
CheckSuiteRequest
CheckType
JObject	Represents a JSON object.
ReferenceLinks	The class to represent a collection of REST reference links.
Resource

CheckConfigurationRef

Name	Type	Description
id	integer	Check configuration id.
resource	Resource	Resource on which check get configured.
type	CheckType	Check configuration type
url	string	The URL from which one can fetch the configured check.

CheckRun

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

CheckRunStatus

Name	Type	Description
all	string
approved	string
canceled	string
completed	string
failed	string
none	string
queued	string
rejected	string
running	string
timedOut	string

CheckSuite

Name	Type	Description
_links	ReferenceLinks	Reference links.
checkRuns	CheckRun[]	List of check runs associated with the given check suite request.
completedDate	string	Completed date of the given check suite request
context	JObject	Evaluation context for the check suite request
id	string	Unique suite id generated by the pipeline orchestrator for the pipeline check runs request on the list of resources Pipeline orchestrator will used this identifier to map the check requests on a stage
message	string	Optional message for the given check suite request
status	CheckRunStatus	Overall check runs status for the given suite request. This is check suite status

CheckSuiteExpandParameter

Name	Type	Description
none	string
resources	string

CheckSuiteRequest

Name	Type	Description
context	JObject	Represents a JSON object.
id	string
resources	Resource[]

CheckType

Name	Type	Description
id	string	Gets or sets check type id.
name	string	Name of the check type.

JObject

Represents a JSON object.

Name	Type	Description
item	string
type	string	Gets the node type for this JToken.

ReferenceLinks

The class to represent a collection of REST reference links.

Name	Type	Description
links	object	The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.

Resource

Name	Type	Description
id	string	Id of the resource.
name	string	Name of the resource.
type	string	Type of the resource.

Delen via