Processes - Create

Reference

Service:: Work Item Tracking Process

API Version:: 7.1-preview.2

Creates a process.

POST https://dev.azure.com/{organization}/_apis/work/processes?api-version=7.1-preview.2

URI Parameters

Name	In	Required	Type	Description
organization	path	True	string	The name of the Azure DevOps organization.
api-version	query	True	string	Version of the API to use. This should be set to '7.1-preview.2' to use this version of the api.

Request Body

Name	Type	Description
description	string	Description of the process
name	string	Name of the process
parentProcessTypeId	string	The ID of the parent process
referenceName	string	Reference name of process being created. If not specified, server will assign a unique reference name

Responses

Name	Type	Description
200 OK	ProcessInfo	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.

Examples

Create the process

Sample Request

HTTP

POST https://dev.azure.com/{organization}/_apis/work/processes?api-version=7.1-preview.2

{
  "name": "MyNewAgileProcess",
  "parentProcessTypeId": "adcc42ab-9882-485e-a3ed-7678f01f66bc",
  "referenceName": "fabrikam.MyNewAgileProcess",
  "description": "My new process"
}

Sample Response

Status code:: 200

{
  "typeId": "fb70612d-c6d5-421a-ace1-04939e81b669",
  "referenceName": "fabrikam.MyNewAgileProcess",
  "name": "MyNewAgileProcess",
  "description": "My new process",
  "parentProcessTypeId": "adcc42ab-9882-485e-a3ed-7678f01f66bc",
  "isEnabled": true,
  "customizationType": "Inherited"
}

Definitions

Name	Description
CreateProcessModel	Describes a process being created.
CustomizationType	Indicates the type of customization on this work item. System behaviors are inherited from parent process but not modified. Inherited behaviors are modified behaviors that were inherited from parent process. Custom behaviors are behaviors created by user in current process.
ProcessInfo	Process.
ProjectReference	Defines the project reference class.

CreateProcessModel

Describes a process being created.

Name	Type	Description
description	string	Description of the process
name	string	Name of the process
parentProcessTypeId	string	The ID of the parent process
referenceName	string	Reference name of process being created. If not specified, server will assign a unique reference name

CustomizationType

Indicates the type of customization on this work item. System behaviors are inherited from parent process but not modified. Inherited behaviors are modified behaviors that were inherited from parent process. Custom behaviors are behaviors created by user in current process.

Name	Type	Description
custom	string	Customization-type is Custom if the newly created workitemtype is customized.
inherited	string	Customization-type is Inherited if the existing workitemtype of inherited process is customized.
system	string	Customization-type is System if is system generated workitemtype.

ProcessInfo

Process.

Name	Type	Description
customizationType	CustomizationType	Indicates the type of customization on this process. System Process is default process. Inherited Process is modified process that was System process before.
description	string	Description of the process.
isDefault	boolean	Is the process default.
isEnabled	boolean	Is the process enabled.
name	string	Name of the process.
parentProcessTypeId	string	ID of the parent process.
projects	ProjectReference[]	Projects in this process to which the user is subscribed to.
referenceName	string	Reference name of the process.
typeId	string	The ID of the process.

ProjectReference

Defines the project reference class.

Name	Type	Description
description	string	Description of the project
id	string	The ID of the project
name	string	Name of the project
url	string	Url of the project