Deliverytimeline - Get

Service:

Work

API Version:

7.1

Get Delivery View Data

GET https://dev.azure.com/{organization}/{project}/_apis/work/plans/{id}/deliverytimeline?api-version=7.1

With optional parameters:

GET https://dev.azure.com/{organization}/{project}/_apis/work/plans/{id}/deliverytimeline?revision={revision}&startDate={startDate}&endDate={endDate}&api-version=7.1

URI Parameters

Name	In	Required	Type	Description
id	path	True	string	Identifier for delivery view
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' to use this version of the api.
endDate	query		string (date-time)	The end date of timeline
revision	query		integer (int32)	Revision of the plan for which you want data. If the current plan is a different revision you will get an ViewRevisionMismatchException exception. If you do not supply a revision you will get data for the latest revision.
startDate	query		string (date-time)	The start date of timeline

Responses

Name	Type	Description
200 OK	DeliveryViewData	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.work	Grants the ability to read work items, queries, boards, area and iterations paths, and other work item tracking related metadata. Also grants the ability to execute queries, search work items and to receive notifications about work item events via service hooks.

Definitions

Name	Description
BacklogLevel	Contract representing a backlog level
DeliveryViewData	Data contract for Data of Delivery View
ParentChildWIMap
TeamFieldValue	Represents a single TeamFieldValue
TimelineCriteriaStatus
TimelineCriteriaStatusCode
TimelineIterationStatus
TimelineIterationStatusCode
TimelineTeamData
TimelineTeamIteration
TimelineTeamStatus
TimelineTeamStatusCode
WorkItemColor	Work item color and icon.

BacklogLevel

Object

Contract representing a backlog level

Name	Type	Description
categoryReferenceName	string	Reference name of the corresponding WIT category
pluralName	string	Plural name for the backlog level
workItemStates	string[]	Collection of work item states that are included in the plan. The server will filter to only these work item types.
workItemTypes	string[]	Collection of valid workitem type names for the given backlog level

DeliveryViewData

Object

Data contract for Data of Delivery View

Name	Type	Description
childIdToParentIdMap	object	Work item child id to parent id map
criteriaStatus	TimelineCriteriaStatus	Filter criteria status of the timeline
endDate	string (date-time)	The end date of the delivery view data
id	string (uuid)
maxExpandedTeams	integer (int32)	Max number of teams that can be configured for a delivery plan
parentItemMaps	ParentChildWIMap[]	Mapping between parent id, title and all the child work item ids
revision	integer (int32)
startDate	string (date-time)	The start date for the delivery view data
teams	TimelineTeamData[]	All the team data
workItemDependencies	integer[] (int32)	List of all work item ids that have a dependency but not a violation
workItemViolations	integer[] (int32)	List of all work item ids that have a violation

ParentChildWIMap

Object

Name	Type	Description
childWorkItemIds	integer[] (int32)
id	integer (int32)
title	string
workItemTypeName	string

TeamFieldValue

Object

Represents a single TeamFieldValue

Name	Type	Description
includeChildren	boolean
value	string

TimelineCriteriaStatus

Object

Name	Type	Description
message	string
type	TimelineCriteriaStatusCode

TimelineCriteriaStatusCode

Enumeration

Value	Description
invalidFilterClause	One of the filter clause is invalid.
ok	No error - filter is good.
unknown	Unknown error.

TimelineIterationStatus

Object

Name	Type	Description
message	string
type	TimelineIterationStatusCode

TimelineIterationStatusCode

Enumeration

Value	Description
isOverlapping	This iteration overlaps with another iteration, no data is returned for this iteration.
ok	No error - iteration data is good.

TimelineTeamData

Object

Name	Type	Description
backlog	BacklogLevel	Backlog matching the mapped backlog associated with this team.
fieldReferenceNames	string[]	The field reference names of the work item data
id	string (uuid)	The id of the team
isExpanded	boolean	Was iteration and work item data retrieved for this team. <remarks> Teams with IsExpanded false have not had their iteration, work item, and field related data queried and will never contain this data. If true then these items are queried and, if there are items in the queried range, there will be data. </remarks>
iterations	TimelineTeamIteration[]	The iteration data, including the work items, in the queried date range.
name	string	The name of the team
orderByField	string	The order by field name of this team
partiallyPagedFieldReferenceNames	string[]	The field reference names of the partially paged work items, such as ID, WorkItemType
partiallyPagedWorkItems	object[]
projectId	string (uuid)	The project id the team belongs team
rollupWorkItemTypes	string[]	Work item types for which we will collect roll up data on the client side
status	TimelineTeamStatus	Status for this team.
teamFieldDefaultValue	string	The team field default value
teamFieldName	string	The team field name of this team
teamFieldValues	TeamFieldValue[]	The team field values
workItemTypeColors	WorkItemColor[]	Colors for the work item types.
workItems	object[]	Work items associated with the team that are not under any of the team's iterations

TimelineTeamIteration

Object

Name	Type	Description
cssNodeId	string	The iteration CSS Node Id
finishDate	string (date-time)	The end date of the iteration
name	string	The iteration name
partiallyPagedWorkItems	object[]	All the partially paged workitems in this iteration.
path	string	The iteration path
startDate	string (date-time)	The start date of the iteration
status	TimelineIterationStatus	The status of this iteration
workItems	object[]	The work items that have been paged in this iteration

TimelineTeamStatus

Object

Name	Type	Description
message	string
type	TimelineTeamStatusCode

TimelineTeamStatusCode

Enumeration

Value	Description
backlogInError	Backlog does not exist or is missing crucial information.
doesntExistOrAccessDenied	Team does not exist or access is denied.
maxTeamFieldsExceeded	Maximum number of team fields (ie Area paths) have been exceeded. No team data will be returned for this team.
maxTeamsExceeded	Maximum number of teams was exceeded. No team data will be returned for this team.
missingTeamFieldValue	Team field value is not set for this team. No team data will be returned for this team
noIterationsExist	Team does not have a single iteration with date range.
ok	No error - all data for team is good.

WorkItemColor

Object

Work item color and icon.

Name	Type	Description
icon	string
primaryColor	string
workItemTypeName	string