Plans - Create
Add a new plan for the team
POST https://dev.azure.com/{organization}/{project}/_apis/work/plans?api-version=7.1URI 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' to use this version of the api. |
Request Body
| Name | Type | Description |
|---|---|---|
| description |
string |
Description of the plan |
| name |
string |
Name of the plan to create. |
| properties |
object |
Plan properties. |
| type |
Type of plan to create. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
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_write | Grants the ability to read, create, and update work items and queries, update board metadata, read area and iterations paths other work item tracking related metadata, execute queries, and to receive notifications about work item events via service hooks. |
Definitions
| Name | Description |
|---|---|
|
Create |
|
|
Identity |
|
| Plan |
Data contract for the plan definition |
|
Plan |
Type of plan to create. |
|
Plan |
Bit flag indicating set of permissions a user has to the plan. |
|
Reference |
The class to represent a collection of REST reference links. |
CreatePlan
| Name | Type | Description |
|---|---|---|
| description |
string |
Description of the plan |
| name |
string |
Name of the plan to create. |
| properties |
object |
Plan properties. |
| type |
Type of plan to create. |
IdentityRef
| Name | Type | Description |
|---|---|---|
| _links |
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 |
Deprecated - Can be retrieved by querying the Graph user referenced in the "self" entry of the IdentityRef "_links" dictionary |
| 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 |
Deprecated - Available in the "avatar" entry of the IdentityRef "_links" dictionary |
| inactive |
boolean |
Deprecated - Can be retrieved by querying the Graph membership state referenced in the "membershipState" entry of the GraphUser "_links" dictionary |
| isAadIdentity |
boolean |
Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType) |
| isContainer |
boolean |
Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType) |
| isDeletedInOrigin |
boolean |
|
| profileUrl |
string |
Deprecated - not in use in most preexisting implementations of ToIdentityRef |
| uniqueName |
string |
Deprecated - use Domain+PrincipalName instead |
| 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 |
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 |
| lastAccessed |
string |
Date when the plan was last accessed. Default is null. |
| modifiedByIdentity |
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 |
Type of the plan |
|
| url |
string |
The resource url to locate the plan via rest api |
| userPermissions |
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. |