Share via

Processes

  • Article

TFS 2017 | TFS 2015 | TFS 2013

Note

Looking for REST APIS that support TFS 2018 or later versions? See the Azure DevOps REST API Reference.

api-version = 1.0

Processes contain configuration settings for projects.

If you haven't already, look at the information on getting started with these APIs.

Get a list of processes

Get all processes in the project collection.

GET https://{instance}/DefaultCollection/_apis/process/processes?api-version={version}
Parameter Type Notes
URL
instance string TFS server name ({server:port}).
api-version string Version of the API to use.

Sample request

GET https://mytfsserver/DefaultCollection/_apis/process/processes?api-version=1.0

Sample response

{
  "count": 3,
  "value": [
    {
      "id": "adcc42ab-9882-485e-a3ed-7678f01f66bc",
      "description": "This template is flexible and will work great for most teams using Agile planning methods, including those practicing Scrum.",
      "isDefault": false,
      "url": "https://mytfsserver/DefaultCollection/_apis/process/processes/adcc42ab-9882-485e-a3ed-7678f01f66bc",
      "name": "Agile"
    },
    {
      "id": "27450541-8e31-4150-9947-dc59f998fc01",
      "description": "This template is for more formal projects requiring a framework for process improvement and an auditable record of decisions.",
      "isDefault": false,
      "url": "https://mytfsserver/DefaultCollection/_apis/process/processes/27450541-8e31-4150-9947-dc59f998fc01",
      "name": "CMMI"
    },
    {
      "id": "6b724908-ef14-45cf-84f8-768b5384da45",
      "description": "This template is for teams who follow the Scrum methodology and use Scrum terminology.",
      "isDefault": true,
      "url": "https://mytfsserver/DefaultCollection/_apis/process/processes/6b724908-ef14-45cf-84f8-768b5384da45",
      "name": "Scrum"
    }
  ]
}

Sample code

Get a process

GET https://{instance}/DefaultCollection/_apis/process/processes/{processId}?api-version={version}
Parameter Type Notes
URL
instance string TFS server name ({server:port}).
processId string ID of the process.
api-version string Version of the API to use.

Sample request

GET https://mytfsserver/DefaultCollection/_apis/process/processes/adcc42ab-9882-485e-a3ed-7678f01f66bc?api-version=1.0

Sample response

{
  "id": "adcc42ab-9882-485e-a3ed-7678f01f66bc",
  "description": "This template is flexible and will work great for most teams using Agile planning methods, including those practicing Scrum.",
  "isDefault": false,
  "_links": {
    "self": {
      "href": "https://mytfsserver/DefaultCollection/_apis/process/processes/adcc42ab-9882-485e-a3ed-7678f01f66bc"
    }
  },
  "url": "https://mytfsserver/DefaultCollection/_apis/process/processes/adcc42ab-9882-485e-a3ed-7678f01f66bc",
  "name": "Agile"
}

Sample code