Processes - Get

Reference

Service:: Work Item Tracking Process

API Version:: 5.0-preview.2

Get a single process of a specified ID.

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

With optional parameters:

GET https://dev.azure.com/{organization}/_apis/work/processes/{processTypeId}?$expand={$expand}&api-version=5.0-preview.2

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 '5.0-preview.2' to use this version of the api.
$expand	query		GetProcessExpandLevel

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	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 specific process

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "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,
  "customizationType": "System",
  "isDefault": true
}

Definitions

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

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
projects	string

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

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

Share via