Plans - List

Service:

Work

API Version:

5.0

Get the information for all the plans configured for the given team

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

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 '5.0' to use this version of the api.

Responses

Name	Type	Description
200 OK	Plan[]	successful operation

Security

accessToken

Personal access token. Use any value for the user name and the token as the password.

Type: basic

Definitions

Name	Description
IdentityRef
Plan	Data contract for the plan definition
PlanType	Type of plan to create.
PlanUserPermissions	Bit flag indicating set of permissions a user has to the plan.
ReferenceLinks	The class to represent a collection of REST reference links.

IdentityRef

Name	Type	Description
_links	ReferenceLinks	This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject.
descriptor	string	The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.
directoryAlias	string
displayName	string	This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.
id	string
imageUrl	string
inactive	boolean
isAadIdentity	boolean
isContainer	boolean
isDeletedInOrigin	boolean
profileUrl	string
uniqueName	string
url	string	This url is the full route to the source resource of this graph subject.

Plan

Data contract for the plan definition

Name	Type	Description
createdByIdentity	IdentityRef	Identity that created this plan. Defaults to null for records before upgrading to ScaledAgileViewComponent4.
createdDate	string	Date when the plan was created
description	string	Description of the plan
id	string	Id of the plan
modifiedByIdentity	IdentityRef	Identity that last modified this plan. Defaults to null for records before upgrading to ScaledAgileViewComponent4.
modifiedDate	string	Date when the plan was last modified. Default to CreatedDate when the plan is first created.
name	string	Name of the plan
properties	object	The PlanPropertyCollection instance associated with the plan. These are dependent on the type of the plan. For example, DeliveryTimelineView, it would be of type DeliveryViewPropertyCollection.
revision	integer	Revision of the plan. Used to safeguard users from overwriting each other's changes.
type	PlanType	Type of the plan
url	string	The resource url to locate the plan via rest api
userPermissions	PlanUserPermissions	Bit flag indicating set of permissions a user has to the plan.

PlanType

Type of plan to create.

Name	Type	Description
deliveryTimelineView	string

PlanUserPermissions

Bit flag indicating set of permissions a user has to the plan.

Name	Type	Description
allPermissions	string	Full control permission for this plan.
delete	string	Permission to delete this plan.
edit	string	Permission to update this plan.
manage	string	Permission to manage this plan.
none	string	None
view	string	Permission to view this plan.

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.