Work Item Types - List

Returns a list of all work item types in a process.

GET https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workitemtypes?api-version=6.0-preview.2
GET https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workitemtypes?$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.

processId
path True
  • string
uuid

The ID of the process

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

Flag to determine what properties of work item type to return

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 a list of all work item types in a process
Get a list of all work item types in a process with expand set to states

Get a list of all work item types in a process

Sample Request

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

Sample Response

{
  "count": 10,
  "value": [
    {
      "referenceName": "MyNewAgileProcess.ChangeRequest",
      "name": "Change Request",
      "description": "This is my description",
      "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/MyNewAgileProcess.ChangeRequest",
      "customization": "custom",
      "color": "f6546a",
      "icon": "icon_airplane",
      "isDisabled": false,
      "inherits": null
    },
    {
      "referenceName": "Microsoft.VSTS.WorkItemTypes.Bug",
      "name": "Bug",
      "description": "Describes a divergence between required and actual behavior, and tracks the work done to correct the defect and verify the correction.",
      "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug",
      "customization": "system",
      "color": "CC293D",
      "icon": "icon_insect",
      "isDisabled": false,
      "inherits": null
    },
    {
      "referenceName": "Microsoft.VSTS.WorkItemTypes.Epic",
      "name": "Epic",
      "description": "Epics help teams effectively manage and groom their product backlog",
      "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.Epic",
      "customization": "system",
      "color": "FF7B00",
      "icon": "icon_crown",
      "isDisabled": false,
      "inherits": null
    },
    {
      "referenceName": "Microsoft.VSTS.WorkItemTypes.Feature",
      "name": "Feature",
      "description": "Tracks a feature that will be released with the product",
      "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.Feature",
      "customization": "system",
      "color": "773B93",
      "icon": "icon_trophy",
      "isDisabled": false,
      "inherits": null
    },
    {
      "referenceName": "Microsoft.VSTS.WorkItemTypes.Task",
      "name": "Task",
      "description": "Tracks work that needs to be done.",
      "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.Task",
      "customization": "system",
      "color": "F2CB1D",
      "icon": "icon_clipboard",
      "isDisabled": false,
      "inherits": null
    },
    {
      "referenceName": "Microsoft.VSTS.WorkItemTypes.TestCase",
      "name": "Test Case",
      "description": "Server-side data for a set of steps to be tested.",
      "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.TestCase",
      "customization": "system",
      "color": "004B50",
      "icon": "icon_test_case",
      "isDisabled": false,
      "inherits": null
    },
    {
      "referenceName": "Microsoft.VSTS.WorkItemTypes.TestPlan",
      "name": "Test Plan",
      "description": "Tracks test activities for a specific milestone or release.",
      "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.TestPlan",
      "customization": "system",
      "color": "004B50",
      "icon": "icon_test_plan",
      "isDisabled": false,
      "inherits": null
    },
    {
      "referenceName": "Microsoft.VSTS.WorkItemTypes.TestSuite",
      "name": "Test Suite",
      "description": "Tracks test activites for a specific feature, requirement, or user story.",
      "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.TestSuite",
      "customization": "system",
      "color": "004B50",
      "icon": "icon_test_suite",
      "isDisabled": false,
      "inherits": null
    },
    {
      "referenceName": "Microsoft.VSTS.WorkItemTypes.UserStory",
      "name": "User Story",
      "description": "Tracks an activity the user will be able to perform with the product",
      "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.UserStory",
      "customization": "system",
      "color": "009CCC",
      "icon": "icon_book",
      "isDisabled": false,
      "inherits": null
    },
    {
      "referenceName": "Microsoft.VSTS.WorkItemTypes.Issue",
      "name": "Issue",
      "description": "Tracks an obstacle to progress.",
      "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.Issue",
      "customization": "system",
      "color": "B4009E",
      "icon": "icon_traffic_cone",
      "isDisabled": false,
      "inherits": null
    }
  ]
}

Get a list of all work item types in a process with expand set to states

Sample Request

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

Sample Response

{
  "count": 10,
  "value": [
    {
      "referenceName": "MyNewAgileProcess.ChangeRequest",
      "name": "Change Request",
      "description": "This is my description",
      "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/MyNewAgileProcess.ChangeRequest",
      "customization": "custom",
      "color": "f6546a",
      "icon": "icon_airplane",
      "isDisabled": false,
      "inherits": null,
      "states": [
        {
          "id": "a97cf44d-d1fd-4b41-b552-c02f7523e84c",
          "name": "New",
          "color": "b2b2b2",
          "stateCategory": "Proposed",
          "order": 1,
          "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/MyNewAgileProcess.ChangeRequest/states/a97cf44d-d1fd-4b41-b552-c02f7523e84c",
          "customizationType": "custom"
        },
        {
          "id": "e4e9b6a9-1fcb-4be9-ab00-6b387f926754",
          "name": "Active",
          "color": "007acc",
          "stateCategory": "InProgress",
          "order": 2,
          "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/MyNewAgileProcess.ChangeRequest/states/e4e9b6a9-1fcb-4be9-ab00-6b387f926754",
          "customizationType": "custom"
        },
        {
          "id": "6fbcb956-7474-4305-90ce-f921e12c83ca",
          "name": "Closed",
          "color": "339933",
          "stateCategory": "Completed",
          "order": 3,
          "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/MyNewAgileProcess.ChangeRequest/states/6fbcb956-7474-4305-90ce-f921e12c83ca",
          "customizationType": "custom"
        }
      ]
    },
    {
      "referenceName": "Microsoft.VSTS.WorkItemTypes.Bug",
      "name": "Bug",
      "description": "Describes a divergence between required and actual behavior, and tracks the work done to correct the defect and verify the correction.",
      "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug",
      "customization": "system",
      "color": "CC293D",
      "icon": "icon_insect",
      "isDisabled": false,
      "inherits": null,
      "states": [
        {
          "id": "7b7e3e8c-e500-40b6-ad56-d59b8d64d757",
          "name": "New",
          "color": "b2b2b2",
          "stateCategory": "Proposed",
          "order": 1,
          "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/states/7b7e3e8c-e500-40b6-ad56-d59b8d64d757",
          "customizationType": "system"
        },
        {
          "id": "277237cd-0bc0-4ffb-bdc6-d358b154ba9e",
          "name": "Active",
          "color": "007acc",
          "stateCategory": "InProgress",
          "order": 2,
          "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/states/277237cd-0bc0-4ffb-bdc6-d358b154ba9e",
          "customizationType": "system"
        },
        {
          "id": "f36cfea7-889a-448e-b5d1-fbc9b134ec82",
          "name": "Resolved",
          "color": "ff9d00",
          "stateCategory": "Resolved",
          "order": 3,
          "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/states/f36cfea7-889a-448e-b5d1-fbc9b134ec82",
          "customizationType": "system"
        },
        {
          "id": "9f479b88-4542-4f9d-8048-5d9c953b5082",
          "name": "Closed",
          "color": "339933",
          "stateCategory": "Completed",
          "order": 4,
          "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/states/9f479b88-4542-4f9d-8048-5d9c953b5082",
          "customizationType": "system"
        }
      ]
    },
    {
      "referenceName": "Microsoft.VSTS.WorkItemTypes.Epic",
      "name": "Epic",
      "description": "Epics help teams effectively manage and groom their product backlog",
      "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.Epic",
      "customization": "system",
      "color": "FF7B00",
      "icon": "icon_crown",
      "isDisabled": false,
      "inherits": null,
      "states": [
        {
          "id": "7b7e3e8c-e500-40b6-ad56-d59b8d64d757",
          "name": "New",
          "color": "b2b2b2",
          "stateCategory": "Proposed",
          "order": 1,
          "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.Epic/states/7b7e3e8c-e500-40b6-ad56-d59b8d64d757",
          "customizationType": "system"
        },
        {
          "id": "277237cd-0bc0-4ffb-bdc6-d358b154ba9e",
          "name": "Active",
          "color": "007acc",
          "stateCategory": "InProgress",
          "order": 2,
          "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.Epic/states/277237cd-0bc0-4ffb-bdc6-d358b154ba9e",
          "customizationType": "system"
        },
        {
          "id": "f36cfea7-889a-448e-b5d1-fbc9b134ec82",
          "name": "Resolved",
          "color": "007acc",
          "stateCategory": "InProgress",
          "order": 3,
          "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.Epic/states/f36cfea7-889a-448e-b5d1-fbc9b134ec82",
          "customizationType": "system"
        },
        {
          "id": "9f479b88-4542-4f9d-8048-5d9c953b5082",
          "name": "Closed",
          "color": "339933",
          "stateCategory": "Completed",
          "order": 4,
          "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.Epic/states/9f479b88-4542-4f9d-8048-5d9c953b5082",
          "customizationType": "system"
        },
        {
          "id": "0293a2ce-2a42-4d0e-bbbf-d2237efa0db8",
          "name": "Removed",
          "color": "ffffff",
          "stateCategory": "Removed",
          "order": 5,
          "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.Epic/states/0293a2ce-2a42-4d0e-bbbf-d2237efa0db8",
          "customizationType": "system"
        }
      ]
    },
    {
      "referenceName": "Microsoft.VSTS.WorkItemTypes.Feature",
      "name": "Feature",
      "description": "Tracks a feature that will be released with the product",
      "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.Feature",
      "customization": "system",
      "color": "773B93",
      "icon": "icon_trophy",
      "isDisabled": false,
      "inherits": null,
      "states": [
        {
          "id": "7b7e3e8c-e500-40b6-ad56-d59b8d64d757",
          "name": "New",
          "color": "b2b2b2",
          "stateCategory": "Proposed",
          "order": 1,
          "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.Feature/states/7b7e3e8c-e500-40b6-ad56-d59b8d64d757",
          "customizationType": "system"
        },
        {
          "id": "277237cd-0bc0-4ffb-bdc6-d358b154ba9e",
          "name": "Active",
          "color": "007acc",
          "stateCategory": "InProgress",
          "order": 2,
          "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.Feature/states/277237cd-0bc0-4ffb-bdc6-d358b154ba9e",
          "customizationType": "system"
        },
        {
          "id": "f36cfea7-889a-448e-b5d1-fbc9b134ec82",
          "name": "Resolved",
          "color": "007acc",
          "stateCategory": "InProgress",
          "order": 3,
          "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.Feature/states/f36cfea7-889a-448e-b5d1-fbc9b134ec82",
          "customizationType": "system"
        },
        {
          "id": "9f479b88-4542-4f9d-8048-5d9c953b5082",
          "name": "Closed",
          "color": "339933",
          "stateCategory": "Completed",
          "order": 4,
          "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.Feature/states/9f479b88-4542-4f9d-8048-5d9c953b5082",
          "customizationType": "system"
        },
        {
          "id": "0293a2ce-2a42-4d0e-bbbf-d2237efa0db8",
          "name": "Removed",
          "color": "ffffff",
          "stateCategory": "Removed",
          "order": 5,
          "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.Feature/states/0293a2ce-2a42-4d0e-bbbf-d2237efa0db8",
          "customizationType": "system"
        }
      ]
    },
    {
      "referenceName": "Microsoft.VSTS.WorkItemTypes.Task",
      "name": "Task",
      "description": "Tracks work that needs to be done.",
      "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.Task",
      "customization": "system",
      "color": "F2CB1D",
      "icon": "icon_clipboard",
      "isDisabled": false,
      "inherits": null,
      "states": [
        {
          "id": "7b7e3e8c-e500-40b6-ad56-d59b8d64d757",
          "name": "New",
          "color": "b2b2b2",
          "stateCategory": "Proposed",
          "order": 1,
          "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.Task/states/7b7e3e8c-e500-40b6-ad56-d59b8d64d757",
          "customizationType": "system"
        },
        {
          "id": "277237cd-0bc0-4ffb-bdc6-d358b154ba9e",
          "name": "Active",
          "color": "007acc",
          "stateCategory": "InProgress",
          "order": 2,
          "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.Task/states/277237cd-0bc0-4ffb-bdc6-d358b154ba9e",
          "customizationType": "system"
        },
        {
          "id": "9f479b88-4542-4f9d-8048-5d9c953b5082",
          "name": "Closed",
          "color": "339933",
          "stateCategory": "Completed",
          "order": 3,
          "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.Task/states/9f479b88-4542-4f9d-8048-5d9c953b5082",
          "customizationType": "system"
        },
        {
          "id": "0293a2ce-2a42-4d0e-bbbf-d2237efa0db8",
          "name": "Removed",
          "color": "ffffff",
          "stateCategory": "Removed",
          "order": 4,
          "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.Task/states/0293a2ce-2a42-4d0e-bbbf-d2237efa0db8",
          "customizationType": "system"
        }
      ]
    },
    {
      "referenceName": "Microsoft.VSTS.WorkItemTypes.TestCase",
      "name": "Test Case",
      "description": "Server-side data for a set of steps to be tested.",
      "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.TestCase",
      "customization": "system",
      "color": "004B50",
      "icon": "icon_test_case",
      "isDisabled": false,
      "inherits": null,
      "states": [
        {
          "id": "067742a4-07cb-4a53-b2fa-2ea058f3332b",
          "name": "Design",
          "color": "b2b2b2",
          "stateCategory": "Proposed",
          "order": 1,
          "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.TestCase/states/067742a4-07cb-4a53-b2fa-2ea058f3332b",
          "customizationType": "system"
        },
        {
          "id": "17cfeadc-f49b-41b9-897a-43655d35c0c4",
          "name": "Ready",
          "color": "007acc",
          "stateCategory": "InProgress",
          "order": 2,
          "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.TestCase/states/17cfeadc-f49b-41b9-897a-43655d35c0c4",
          "customizationType": "system"
        },
        {
          "id": "9f479b88-4542-4f9d-8048-5d9c953b5082",
          "name": "Closed",
          "color": "339933",
          "stateCategory": "Completed",
          "order": 3,
          "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.TestCase/states/9f479b88-4542-4f9d-8048-5d9c953b5082",
          "customizationType": "system"
        }
      ]
    },
    {
      "referenceName": "Microsoft.VSTS.WorkItemTypes.TestPlan",
      "name": "Test Plan",
      "description": "Tracks test activities for a specific milestone or release.",
      "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.TestPlan",
      "customization": "system",
      "color": "004B50",
      "icon": "icon_test_plan",
      "isDisabled": false,
      "inherits": null,
      "states": [
        {
          "id": "277237cd-0bc0-4ffb-bdc6-d358b154ba9e",
          "name": "Active",
          "color": "007acc",
          "stateCategory": "InProgress",
          "order": 1,
          "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.TestPlan/states/277237cd-0bc0-4ffb-bdc6-d358b154ba9e",
          "customizationType": "system"
        },
        {
          "id": "da8f3a6e-e52d-4d1d-9890-783a1bca5da1",
          "name": "Inactive",
          "color": "339933",
          "stateCategory": "Completed",
          "order": 2,
          "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.TestPlan/states/da8f3a6e-e52d-4d1d-9890-783a1bca5da1",
          "customizationType": "system"
        }
      ]
    },
    {
      "referenceName": "Microsoft.VSTS.WorkItemTypes.TestSuite",
      "name": "Test Suite",
      "description": "Tracks test activites for a specific feature, requirement, or user story.",
      "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.TestSuite",
      "customization": "system",
      "color": "004B50",
      "icon": "icon_test_suite",
      "isDisabled": false,
      "inherits": null,
      "states": [
        {
          "id": "93320ff7-1042-403d-93b8-b8ed5dcf2663",
          "name": "In Planning",
          "color": "007acc",
          "stateCategory": "InProgress",
          "order": 1,
          "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.TestSuite/states/93320ff7-1042-403d-93b8-b8ed5dcf2663",
          "customizationType": "system"
        },
        {
          "id": "5fcb8472-3c27-43f5-af7d-f39c9e48f7c6",
          "name": "In Progress",
          "color": "007acc",
          "stateCategory": "InProgress",
          "order": 2,
          "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.TestSuite/states/5fcb8472-3c27-43f5-af7d-f39c9e48f7c6",
          "customizationType": "system"
        },
        {
          "id": "d6920af5-ea13-4c20-aab6-f48d807fbda1",
          "name": "Completed",
          "color": "339933",
          "stateCategory": "Completed",
          "order": 3,
          "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.TestSuite/states/d6920af5-ea13-4c20-aab6-f48d807fbda1",
          "customizationType": "system"
        }
      ]
    },
    {
      "referenceName": "Microsoft.VSTS.WorkItemTypes.UserStory",
      "name": "User Story",
      "description": "Tracks an activity the user will be able to perform with the product",
      "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.UserStory",
      "customization": "system",
      "color": "009CCC",
      "icon": "icon_book",
      "isDisabled": false,
      "inherits": null,
      "states": [
        {
          "id": "7b7e3e8c-e500-40b6-ad56-d59b8d64d757",
          "name": "New",
          "color": "b2b2b2",
          "stateCategory": "Proposed",
          "order": 1,
          "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.UserStory/states/7b7e3e8c-e500-40b6-ad56-d59b8d64d757",
          "customizationType": "system"
        },
        {
          "id": "277237cd-0bc0-4ffb-bdc6-d358b154ba9e",
          "name": "Active",
          "color": "007acc",
          "stateCategory": "InProgress",
          "order": 2,
          "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.UserStory/states/277237cd-0bc0-4ffb-bdc6-d358b154ba9e",
          "customizationType": "system"
        },
        {
          "id": "f36cfea7-889a-448e-b5d1-fbc9b134ec82",
          "name": "Resolved",
          "color": "007acc",
          "stateCategory": "InProgress",
          "order": 3,
          "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.UserStory/states/f36cfea7-889a-448e-b5d1-fbc9b134ec82",
          "customizationType": "system"
        },
        {
          "id": "9f479b88-4542-4f9d-8048-5d9c953b5082",
          "name": "Closed",
          "color": "339933",
          "stateCategory": "Completed",
          "order": 4,
          "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.UserStory/states/9f479b88-4542-4f9d-8048-5d9c953b5082",
          "customizationType": "system"
        },
        {
          "id": "0293a2ce-2a42-4d0e-bbbf-d2237efa0db8",
          "name": "Removed",
          "color": "ffffff",
          "stateCategory": "Removed",
          "order": 5,
          "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.UserStory/states/0293a2ce-2a42-4d0e-bbbf-d2237efa0db8",
          "customizationType": "system"
        }
      ]
    },
    {
      "referenceName": "Microsoft.VSTS.WorkItemTypes.Issue",
      "name": "Issue",
      "description": "Tracks an obstacle to progress.",
      "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.Issue",
      "customization": "system",
      "color": "B4009E",
      "icon": "icon_traffic_cone",
      "isDisabled": false,
      "inherits": null,
      "states": [
        {
          "id": "277237cd-0bc0-4ffb-bdc6-d358b154ba9e",
          "name": "Active",
          "color": "007acc",
          "stateCategory": "InProgress",
          "order": 1,
          "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.Issue/states/277237cd-0bc0-4ffb-bdc6-d358b154ba9e",
          "customizationType": "system"
        },
        {
          "id": "9f479b88-4542-4f9d-8048-5d9c953b5082",
          "name": "Closed",
          "color": "339933",
          "stateCategory": "Completed",
          "order": 2,
          "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/Microsoft.VSTS.WorkItemTypes.Issue/states/9f479b88-4542-4f9d-8048-5d9c953b5082",
          "customizationType": "system"
        }
      ]
    }
  ]
}

Definitions

Control

Represent a control in the form.

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.

Extension

Represents the extensions part of the layout

FormLayout

Describes the layout of a work item type

GetWorkItemTypeExpand

Flag to determine what properties of work item type to return

Group

Represent a group in the form that holds controls in it.

Page

Describes a page in the work item form layout

PageType

The icon for the page.

ProcessWorkItemType

Class that describes a work item type object

Section

Defines a section of the work item form layout

WitContribution

Properties of a work item form contribution

WorkItemBehaviorReference

Reference to the behavior of a work item type.

WorkItemStateResultModel

Class that represents a work item state result.

WorkItemTypeBehavior

Association between a work item type and it's behavior

Control

Represent a control in the form.

Name Type Description
contribution

Contribution for the control.

controlType
  • string

Type of the control.

height
  • integer

Height of the control, for html controls.

id
  • string

The id for the layout node.

inherited
  • boolean

A value indicating whether this layout node has been inherited. from a parent layout. This is expected to only be only set by the combiner.

isContribution
  • boolean

A value indicating if the layout node is contribution or not.

label
  • string

Label for the field.

metadata
  • string

Inner text of the control.

order
  • integer

Order in which the control should appear in its group.

overridden
  • boolean

A value indicating whether this layout node has been overridden . by a child layout.

readOnly
  • boolean

A value indicating if the control is readonly.

visible
  • boolean

A value indicating if the control should be hidden or not.

watermark
  • string

Watermark text for the textbox.

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.

Extension

Represents the extensions part of the layout

Name Type Description
id
  • string

Id of the extension

FormLayout

Describes the layout of a work item type

Name Type Description
extensions

Gets and sets extensions list.

pages

Top level tabs of the layout.

systemControls

Headers controls of the layout.

GetWorkItemTypeExpand

Flag to determine what properties of work item type to return

Name Type Description
behaviors
  • string

Returns behaviors property in get work item type response.

layout
  • string

Returns layout property in get work item type response.

none
  • string

Returns no properties in get work item type response.

states
  • string

Returns states property in get work item type response.

Group

Represent a group in the form that holds controls in it.

Name Type Description
contribution

Contribution for the group.

controls

Controls to be put in the group.

height
  • integer

The height for the contribution.

id
  • string

The id for the layout node.

inherited
  • boolean

A value indicating whether this layout node has been inherited from a parent layout. This is expected to only be only set by the combiner.

isContribution
  • boolean

A value indicating if the layout node is contribution are not.

label
  • string

Label for the group.

order
  • integer

Order in which the group should appear in the section.

overridden
  • boolean

A value indicating whether this layout node has been overridden by a child layout.

visible
  • boolean

A value indicating if the group should be hidden or not.

Page

Describes a page in the work item form layout

Name Type Description
contribution

Contribution for the page.

id
  • string

The id for the layout node.

inherited
  • boolean

A value indicating whether this layout node has been inherited from a parent layout. This is expected to only be only set by the combiner.

isContribution
  • boolean

A value indicating if the layout node is contribution are not.

label
  • string

The label for the page.

locked
  • boolean

A value indicating whether any user operations are permitted on this page and the contents of this page

order
  • integer

Order in which the page should appear in the layout.

overridden
  • boolean

A value indicating whether this layout node has been overridden by a child layout.

pageType

The icon for the page.

sections

The sections of the page.

visible
  • boolean

A value indicating if the page should be hidden or not.

PageType

The icon for the page.

Name Type Description
attachments
  • string

Attachment page type.

custom
  • string

Custom page type.

history
  • string

History page type.

links
  • string

Link page type.

ProcessWorkItemType

Class that describes a work item type object

Name Type Description
behaviors

Association between a work item type and it's behavior

color
  • string

Color hexadecimal code to represent the work item type

customization

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

description
  • string

Description of the work item type

icon
  • string

Icon to represent the work item typ

inherits
  • string

Reference name of the parent work item type

isDisabled
  • boolean

Indicates if a work item type is disabled

layout

Describes the layout of a work item type

name
  • string

Name of the work item type

referenceName
  • string

Reference name of work item type

states

Class that represents a work item state result.

url
  • string

Url of the work item type

Section

Defines a section of the work item form layout

Name Type Description
groups

List of child groups in this section

id
  • string

The id for the layout node.

overridden
  • boolean

A value indicating whether this layout node has been overridden by a child layout.

WitContribution

Properties of a work item form contribution

Name Type Description
contributionId
  • string

The id for the contribution.

height
  • integer

The height for the contribution.

inputs
  • object

A dictionary holding key value pairs for contribution inputs.

showOnDeletedWorkItem
  • boolean

A value indicating if the contribution should be show on deleted workItem.

WorkItemBehaviorReference

Reference to the behavior of a work item type.

Name Type Description
id
  • string

The ID of the reference behavior.

url
  • string

The url of the reference behavior.

WorkItemStateResultModel

Class that represents a work item state result.

Name Type Description
color
  • string

Work item state color.

customizationType

Work item state customization type.

hidden
  • boolean

If the Work item state is hidden.

id
  • string

Id of the Workitemstate.

name
  • string

Work item state name.

order
  • integer

Work item state order.

stateCategory
  • string

Work item state statecategory.

url
  • string

Work item state url.

WorkItemTypeBehavior

Association between a work item type and it's behavior

Name Type Description
behavior

Reference to the behavior of a work item type

isDefault
  • boolean

If true the work item type is the default work item type in the behavior

url
  • string

URL of the work item type behavior