Work Item Types - Get Work Item Types

Service:

Work Item Tracking Process Definitions

API Version:

4.1-preview.1

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

GET https://dev.azure.com/{organization}/_apis/work/processdefinitions/{processId}/workitemtypes?api-version=4.1-preview.1

With optional parameters:

GET https://dev.azure.com/{organization}/_apis/work/processdefinitions/{processId}/workitemtypes?$expand={$expand}&api-version=4.1-preview.1

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 '4.1-preview.1' to use this version of the api.
$expand	query		GetWorkItemTypeExpand

Responses

Name	Type	Description
200 OK	WorkItemTypeModel[]	successful operation

Security

accessToken

Personal access token. Use any value for the user name and the token as the password.

Type: basic

Examples

Get work item types

Sample request

HTTP

GET https://dev.azure.com/{organization}/_apis/work/processdefinitions/{processId}/workitemtypes?api-version=4.1-preview.1

Sample response

Status code:

200

{
  "count": 3,
  "value": [
    {
      "id": "myAgile.CustomWIT",
      "name": "CustomWIT",
      "description": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/myAgile.CustomWIT",
      "inherits": null,
      "class": "custom",
      "color": "009CCC",
      "icon": "icon_clipboard",
      "isDisabled": false
    },
    {
      "id": "myAgile.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/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/myAgile.Bug",
      "inherits": "Microsoft.VSTS.WorkItemTypes.Bug",
      "class": "derived",
      "color": "CC293D",
      "icon": "icon_insect",
      "isDisabled": false
    },
    {
      "id": "myAgile.Epic",
      "name": "Epic",
      "description": "Epics help teams effectively manage and groom their product backlog",
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/myAgile.Epic",
      "inherits": "Microsoft.VSTS.WorkItemTypes.Epic",
      "class": "derived",
      "color": "FF7B00",
      "icon": "icon_crown",
      "isDisabled": false
    }
  ]
}

Definitions

Name	Description
Control	Represent a control in the form.
Extension	Represents the extensions part of the layout
FormLayout
GetWorkItemTypeExpand
Group	Represent a group in the form that holds controls in it.
Page
PageType	The icon for the page.
Section	A layout node holding groups together in a page
WitContribution
WorkItemBehaviorReference
WorkItemStateResultModel
WorkItemTypeBehavior
WorkItemTypeClass	Class of the work item type
WorkItemTypeModel

Control

Object

Represent a control in the form.

Name	Type	Description
contribution	WitContribution	Contribution for the control.
controlType	string	Type of the control.
height	integer (int32)	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 (int32)
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.

Extension

Object

Represents the extensions part of the layout

Name	Type	Description
id	string

FormLayout

Object

Name	Type	Description
extensions	Extension[]	Gets and sets extensions list
pages	Page[]	Top level tabs of the layout.
systemControls	Control[]	Headers controls of the layout.

GetWorkItemTypeExpand

Enumeration

Value	Description
behaviors
layout
none
states

Group

Object

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

Name	Type	Description
contribution	WitContribution	Contribution for the group.
controls	Control[]	Controls to be put in the group.
height	integer (int32)	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 (int32)	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

Object

Name	Type	Description
contribution	WitContribution	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 (int32)	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	PageType	The icon for the page.
sections	Section[]	The sections of the page.
visible	boolean	A value indicating if the page should be hidden or not.

PageType

Enumeration

The icon for the page.

Value	Description
attachments
custom
history
links

Section

Object

A layout node holding groups together in a page

Name	Type	Description
groups	Group[]	Represent a group in the form that holds controls in it.
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

Object

Name	Type	Description
contributionId	string	The id for the contribution.
height	integer (int32)	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

Object

Name	Type	Description
id	string	The ID of the reference behavior
url	string	The url of the reference behavior

WorkItemStateResultModel

Object

Name	Type	Description
color	string	Color of the state
hidden	boolean	Is the state hidden
id	string (uuid)	The ID of the State
name	string	Name of the state
order	integer (int32)	Order in which state should appear
stateCategory	string	Category of the state
url	string	Url of the state

WorkItemTypeBehavior

Object

Name	Type	Description
behavior	WorkItemBehaviorReference
isDefault	boolean
url	string

WorkItemTypeClass

Enumeration

Class of the work item type

Value	Description
custom
derived
system

WorkItemTypeModel

Object

Name	Type	Description
behaviors	WorkItemTypeBehavior[]	Behaviors of the work item type
class	WorkItemTypeClass	Class of the work item type
color	string	Color of the work item type
description	string	Description of the work item type
icon	string	Icon of the work item type
id	string	The ID of the work item type
inherits	string	Parent WIT Id/Internal ReferenceName that it inherits from
isDisabled	boolean	Is work item type disabled
layout	FormLayout	Layout of the work item type
name	string	Name of the work item type
states	WorkItemStateResultModel[]	States of the work item type
url	string	Url of the work item type