Processes - List

Get list of all processes including system and inherited.

GET https://dev.azure.com/{organization}/_apis/work/processes?api-version=6.0-preview.2
GET https://dev.azure.com/{organization}/_apis/work/processes?$expand={$expand}&api-version=6.0-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 '6.0-preview.2' to use this version of the api.

$expand
query

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 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.

Examples

Get the list of processes

Sample Request

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

Sample Response

{
  "count": 14,
  "value": [
    {
      "typeId": "adcc42ab-9882-485e-a3ed-7678f01f66bc",
      "referenceName": null,
      "name": "Agile",
      "description": "This template is flexible and will work great for most teams using Agile planning methods, including those practicing Scrum.",
      "parentProcessTypeId": "00000000-0000-0000-0000-000000000000",
      "isEnabled": true,
      "isDefault": true,
      "customizationType": "System"
    },
    {
      "typeId": "27450541-8e31-4150-9947-dc59f998fc01",
      "referenceName": null,
      "name": "CMMI",
      "description": "This template is for more formal projects requiring a framework for process improvement and an auditable record of decisions.",
      "parentProcessTypeId": "00000000-0000-0000-0000-000000000000",
      "isEnabled": true,
      "isDefault": false,
      "customizationType": "System"
    },
    {
      "typeId": "6b724908-ef14-45cf-84f8-768b5384da45",
      "referenceName": null,
      "name": "Scrum",
      "description": "This template is for teams who follow the Scrum framework.",
      "parentProcessTypeId": "00000000-0000-0000-0000-000000000000",
      "isEnabled": true,
      "isDefault": false,
      "customizationType": "System"
    },
    {
      "typeId": "e31fd6e1-c6af-44bb-925e-dfa71f551463",
      "referenceName": null,
      "name": "CustomProcess",
      "description": "This template is flexible and will work great for most teams using Agile planning methods, including those practicing Scrum.",
      "parentProcessTypeId": "00000000-0000-0000-0000-000000000000",
      "isEnabled": true,
      "isDefault": false,
      "customizationType": "Inherited"
    }
  ]
}

Definitions

CustomizationType

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

GetProcessExpandLevel
ProcessInfo

Process.

ProjectReference

Defines the project reference class.

CustomizationType

Indicates the type of customization on this work item. System behaviors are inherited from parent process but not modified. Inherited behaviors are modified 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.

GetProcessExpandLevel

Name Type Description
none
  • string

No expand level.

projects
  • string

Projects expand level.

ProcessInfo

Process.

Name Type Description
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

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