Processes - Update

Service:

Work Item Tracking Process

API Version:

4.1-preview.1

Updates a process of a specific ID.

PATCH https://dev.azure.com/{organization}/_apis/work/processes/{processTypeId}?api-version=4.1-preview.1

URI Parameters

Name	In	Required	Type	Description
organization	path	True	string	The name of the Azure DevOps organization.
processTypeId	path	True	string (uuid)
api-version	query	True	string	Version of the API to use. This should be set to '4.1-preview.1' to use this version of the api.

Request Body

Name	Type	Description
description	string
isDefault	boolean
isEnabled	boolean
name	string

Responses

Name	Type	Description
200 OK	ProcessModel	successful operation

Security

accessToken

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

Type: basic

Examples

Update the process definition

Sample request

HTTP

PATCH https://dev.azure.com/{organization}/_apis/work/processes/{processTypeId}?api-version=4.1-preview.1

{
  "name": "MyNewAgileProcess_Renamed",
  "description": "My new renamed process",
  "IsDefault": "false",
  "IsEnabled": "false"
}

Sample response

Status code:

200

{
  "typeId": "fb70612d-c6d5-421a-ace1-04939e81b669",
  "referenceName": "fabrikam.MyNewAgileProcess",
  "name": "MyNewAgileProcess_Renamed",
  "description": "My new renamed process",
  "properties": {
    "class": "derived",
    "parentProcessTypeId": "adcc42ab-9882-485e-a3ed-7678f01f66bc",
    "isEnabled": false,
    "version": "1.0",
    "isDefault": false
  }
}

Definitions

Name	Description
ProcessClass	Class of the process
ProcessModel
ProcessProperties	Properties of the process
ProjectReference
UpdateProcessModel

ProcessClass

Enumeration

Class of the process

Value	Description
custom
derived
system

ProcessModel

Object

Name	Type	Description
description	string	Description of the process
name	string	Name of the process
projects	ProjectReference[]	Projects in this process
properties	ProcessProperties	Properties of the process
referenceName	string	Reference name of the process
typeId	string (uuid)	The ID of the process

ProcessProperties

Object

Properties of the process

Name	Type	Description
class	ProcessClass	Class of the process
isDefault	boolean	Is the process default process
isEnabled	boolean	Is the process enabled
parentProcessTypeId	string (uuid)	ID of the parent process
version	string	Version of the process

ProjectReference

Object

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

UpdateProcessModel

Object

Name	Type	Description
description	string
isDefault	boolean
isEnabled	boolean
name	string