Timeline - Get

Service:

Build

API Version:

6.0

Gets details for a build

GET https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/timeline/{timelineId}?api-version=6.0

With optional parameters:

GET https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/timeline/{timelineId}?changeId={changeId}&planId={planId}&api-version=6.0

URI Parameters

Name	In	Required	Type	Description
buildId	path	True	integer int32
organization	path	True	string	The name of the Azure DevOps organization.
project	path	True	string	Project ID or project name
timelineId	path		string uuid
api-version	query	True	string	Version of the API to use. This should be set to '6.0' to use this version of the api.
changeId	query		integer int32
planId	query		string uuid

Responses

Name	Type	Description
200 OK	Timeline	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
BuildLogReference	Represents a reference to a build log.
Issue	Represents an issue (error, warning) associated with a build.
IssueType	The type (error, warning) of the issue.
ReferenceLinks	The class to represent a collection of REST reference links.
TaskReference	Represents a reference to a task.
TaskResult	The result.
Timeline	Represents the timeline of a build.
TimelineAttempt
TimelineRecord	Represents an entry in a build's timeline.
TimelineRecordState	The state of the record.
TimelineReference	Represents a reference to a timeline.

BuildLogReference

Represents a reference to a build log.

Name	Type	Description
id	integer	The ID of the log.
type	string	The type of the log location.
url	string	A full link to the log resource.

Issue

Represents an issue (error, warning) associated with a build.

Name	Type	Description
category	string	The category.
data	object
message	string	A description of the issue.
type	IssueType	The type (error, warning) of the issue.

IssueType

The type (error, warning) of the issue.

Name	Type	Description
error	string
warning	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.

TaskReference

Represents a reference to a task.

Name	Type	Description
id	string	The ID of the task definition.
name	string	The name of the task definition.
version	string	The version of the task definition.

TaskResult

The result.

Name	Type	Description
abandoned	string
canceled	string
failed	string
skipped	string
succeeded	string
succeededWithIssues	string

Timeline

Represents the timeline of a build.

Name	Type	Description
changeId	integer	The change ID.
id	string	The ID of the timeline.
lastChangedBy	string	The process or person that last changed the timeline.
lastChangedOn	string	The time the timeline was last changed.
records	TimelineRecord[]	Represents an entry in a build's timeline.
url	string	The REST URL of the timeline.

TimelineAttempt

Name	Type	Description
attempt	integer	Gets or sets the attempt of the record.
recordId	string	Gets or sets the record identifier located within the specified timeline.
timelineId	string	Gets or sets the timeline identifier which owns the record representing this attempt.

TimelineRecord

Represents an entry in a build's timeline.

Name	Type	Description
_links	ReferenceLinks	The class to represent a collection of REST reference links.
attempt	integer	Attempt number of record.
changeId	integer	The change ID.
currentOperation	string	A string that indicates the current operation.
details	TimelineReference	A reference to a sub-timeline.
errorCount	integer	The number of errors produced by this operation.
finishTime	string	The finish time.
id	string	The ID of the record.
identifier	string	String identifier that is consistent across attempts.
issues	Issue[]	Represents an issue (error, warning) associated with a build.
lastModified	string	The time the record was last modified.
log	BuildLogReference	A reference to the log produced by this operation.
name	string	The name.
order	integer	An ordinal value relative to other records.
parentId	string	The ID of the record's parent.
percentComplete	integer	The current completion percentage.
previousAttempts	TimelineAttempt[]
queueId	integer	The queue ID of the queue that the operation ran on.
result	TaskResult	The result.
resultCode	string	The result code.
startTime	string	The start time.
state	TimelineRecordState	The state of the record.
task	TaskReference	A reference to the task represented by this timeline record.
type	string	The type of the record.
url	string	The REST URL of the timeline record.
warningCount	integer	The number of warnings produced by this operation.
workerName	string	The name of the agent running the operation.

TimelineRecordState

The state of the record.

Name	Type	Description
completed	string
inProgress	string
pending	string

TimelineReference

Represents a reference to a timeline.

Name	Type	Description
changeId	integer	The change ID.
id	string	The ID of the timeline.
url	string	The REST URL of the timeline.