Process Configuration

Last Update: 12/5/2016

api-version = 2.0-preview.1

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

Get a project's process configuration

Team projects have process configuration, process configuration defines the behavior of backlogs and boards.

Setting Name Description
typeFields Specifies a collection of TypeFields. TypeFields are abstractions of customizable fields. For example, the type of the "Story points" field is "Effort".
taskBacklog Specifies the state and work item types for sprint backlog.
requirementBacklog Specifies the state and work item types for requirement backlog.
portfolioBacklogs Specifies the state and work item types for portfolio backlogs.
bugWorkItems Specifies the state and work item types for bugs.
GET https://{instance}/DefaultCollection/{project}/_apis/Work/ProcessConfiguration?api-version={version}
Parameter Type Notes
URL
instance string VS Team Services account ({account}.visualstudio.com) or TFS server ({server:port}).
project string Name or ID of the project.
Query
api-version string Version of the API to use.

Sample request

GET https://fabrikam-fiber-inc.visualstudio.com/DefaultCollection/Fabrikam-Fiber/_apis/work/processconfiguration?api-version=2.0-preview.1

Sample response

Status code: 200
{
  "typeFields": {
    "Effort": {
      "referenceName": "Microsoft.VSTS.Scheduling.StoryPoints",
      "name": "Story Points",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/DefaultCollection/_apis/wit/fields/Microsoft.VSTS.Scheduling.StoryPoints"
    },
    "Order": {
      "referenceName": "Microsoft.VSTS.Common.StackRank",
      "name": "Stack Rank",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/DefaultCollection/_apis/wit/fields/Microsoft.VSTS.Common.StackRank"
    },
    "RemainingWork": {
      "referenceName": "Microsoft.VSTS.Scheduling.RemainingWork",
      "name": "Remaining Work",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/DefaultCollection/_apis/wit/fields/Microsoft.VSTS.Scheduling.RemainingWork"
    },
    "Team": {
      "referenceName": "System.AreaPath",
      "name": "Area Path",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/DefaultCollection/_apis/wit/fields/System.AreaPath"
    },
    "Activity": {
      "referenceName": "Microsoft.VSTS.Common.Activity",
      "name": "Activity",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/DefaultCollection/_apis/wit/fields/Microsoft.VSTS.Common.Activity"
    }
  },
  "taskBacklog": {
    "name": "Tasks",
    "referenceName": "Microsoft.TaskCategory",
    "workItemTypes": [
      {
        "name": "Task",
        "url": "https://fabrikam-fiber-inc.visualstudio.com/DefaultCollection/60a4cee6-bcb6-4c30-9699-5e76c0d064ce/_apis/wit/workItemTypes/Task"
      }
    ]
  },
  "requirementBacklog": {
    "name": "Stories",
    "referenceName": "Microsoft.RequirementCategory",
    "workItemTypes": [
      {
        "name": "User Story",
        "url": "https://fabrikam-fiber-inc.visualstudio.com/DefaultCollection/60a4cee6-bcb6-4c30-9699-5e76c0d064ce/_apis/wit/workItemTypes/User%20Story"
      }
    ]
  },
  "portfolioBacklogs": [
    {
      "name": "Epics",
      "referenceName": "Microsoft.EpicCategory",
      "workItemTypes": [
        {
          "name": "Epic",
          "url": "https://fabrikam-fiber-inc.visualstudio.com/DefaultCollection/60a4cee6-bcb6-4c30-9699-5e76c0d064ce/_apis/wit/workItemTypes/Epic"
        }
      ]
    },
    {
      "name": "Features",
      "referenceName": "Microsoft.FeatureCategory",
      "workItemTypes": [
        {
          "name": "Feature",
          "url": "https://fabrikam-fiber-inc.visualstudio.com/DefaultCollection/60a4cee6-bcb6-4c30-9699-5e76c0d064ce/_apis/wit/workItemTypes/Feature"
        }
      ]
    }
  ],
  "bugWorkItems": {
    "name": "Bugs",
    "referenceName": "Microsoft.BugCategory",
    "workItemTypes": [
      {
        "name": "Bug",
        "url": "https://fabrikam-fiber-inc.visualstudio.com/DefaultCollection/60a4cee6-bcb6-4c30-9699-5e76c0d064ce/_apis/wit/workItemTypes/Bug"
      }
    ]
  },
  "url": "https://fabrikam-fiber-inc.visualstudio.com/DefaultCollection/60a4cee6-bcb6-4c30-9699-5e76c0d064ce/_apis/work/processconfiguration"
}