Runs - Get

Service:

Pipelines

API Version:

7.1-preview.1

Gets a run for a particular pipeline.

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

URI Parameters

Name	In	Required	Type	Description
organization	path	True	string	The name of the Azure DevOps organization.
pipelineId	path	True	integer int32	The pipeline id
project	path	True	string	Project ID or project name
runId	path	True	integer int32	The run id
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.

Responses

Name	Type	Description
200 OK	Run	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	Grants the ability to access build artifacts, including build results, definitions, and requests, and the ability to receive notifications about build events via service hooks.

Definitions

Name	Description
Container
ContainerResource
PipelineReference	A reference to a Pipeline.
PipelineResource
ReferenceLinks	The class to represent a collection of REST reference links.
Repository
RepositoryResource
RepositoryType
Run
RunResources
RunResult
RunState
Variable

Container

Name	Type	Description
environment	object
image	string
mapDockerSocket	boolean
options	string
ports	string[]
volumes	string[]

ContainerResource

Name	Type	Description
container	Container

PipelineReference

A reference to a Pipeline.

Name	Type	Description
folder	string	Pipeline folder
id	integer	Pipeline ID
name	string	Pipeline name
revision	integer	Revision number
url	string

PipelineResource

Name	Type	Description
pipeline	PipelineReference	A reference to a Pipeline.
version	string

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.

Repository

Name	Type	Description
type	RepositoryType

RepositoryResource

Name	Type	Description
refName	string
repository	Repository
version	string

RepositoryType

Name	Type	Description
azureReposGit	string
azureReposGitHyphenated	string
gitHub	string
gitHubEnterprise	string
unknown	string

Run

Name	Type	Description
_links	ReferenceLinks	The class to represent a collection of REST reference links.
createdDate	string
finalYaml	string
finishedDate	string
id	integer
name	string
pipeline	PipelineReference	A reference to a Pipeline.
resources	RunResources
result	RunResult
state	RunState
templateParameters	object
url	string
variables	<string,  Variable>

RunResources

Name	Type	Description
containers	<string,  ContainerResource>
pipelines	<string,  PipelineResource>
repositories	<string,  RepositoryResource>

RunResult

Name	Type	Description
canceled	string
failed	string
succeeded	string
unknown	string

RunState

Name	Type	Description
canceling	string
completed	string
inProgress	string
unknown	string

Variable

Name	Type	Description
isSecret	boolean
value	string