Work Item Types - Update

Reference

Service:: Work Item Tracking Process

API Version:: 7.1

Updates a work item type of the process.

PATCH https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workitemtypes/{witRefName}?api-version=7.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
witRefName	path	True	string	The reference name of the work item type
api-version	query	True	string	Version of the API to use. This should be set to '7.1' to use this version of the api.

Request Body

Name	Type	Description
color	string	Color of the work item type
description	string	Description of the work item type
icon	string	Icon of the work item type
isDisabled	boolean	If set will disable the work item type

Responses

Name	Type	Description
200 OK	ProcessWorkItemType	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_write	Grants the ability to read, create, and update work items and queries, update board metadata, read area and iterations paths other work item tracking related metadata, execute queries, and to receive notifications about work item events via service hooks.

Examples

Updates a work item type in the process

Sample request

HTTP

PATCH https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workitemtypes/{witRefName}?api-version=7.1

{
  "description": "This is my description",
  "color": null,
  "icon": null,
  "isDisabled": false
}

Sample response

Status code:: 200

{
  "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": null,
  "isDisabled": false,
  "inherits": null
}

Definitions

Name	Description
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 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
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
UpdateProcessWorkItemTypeRequest	Class for update request on a work item type
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	WitContribution	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 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	Extension[]	Gets and sets extensions list.
pages	Page[]	Top level tabs of the layout.
systemControls	Control[]	Headers controls of the layout.

Group

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

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	WorkItemTypeBehavior[]	Association between a work item type and it's behavior
color	string	Color hexadecimal code to represent the work item type
customization	CustomizationType	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	FormLayout	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	WorkItemStateResultModel[]	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	Group[]	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.

UpdateProcessWorkItemTypeRequest

Class for update request on a work item type

Name	Type	Description
color	string	Color of the work item type
description	string	Description of the work item type
icon	string	Icon of the work item type
isDisabled	boolean	If set will disable the work item type

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	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	WorkItemBehaviorReference	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
isLegacyDefault	boolean	If true the work item type is the default work item type in the parent behavior
url	string	URL of the work item type behavior

Share via