Fields - Update
Updates a field in a work item type.
PATCH https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/fields/{fieldRefName}?api-version=7.1-preview.2
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
field
|
path | True |
string |
The reference name of the field. |
organization
|
path | True |
string |
The name of the Azure DevOps organization. |
process
|
path | True |
string uuid |
The ID of the process. |
wit
|
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-preview.2' to use this version of the api. |
Request Body
Name | Type | Description |
---|---|---|
allowGroups |
boolean |
Allow setting field value to a group identity. Only applies to identity fields. |
allowedValues |
string[] |
The list of field allowed values. |
defaultValue |
object |
The default value of the field. |
readOnly |
boolean |
If true the field cannot be edited. |
required |
boolean |
The default value of the field. |
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_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 field in a work item type
Sample Request
PATCH https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/fields/{fieldRefName}?api-version=7.1-preview.2
{
"defaultValue": "Blue"
}
Sample Response
{
"referenceName": "Custom.Fields.Colors",
"name": "Colors",
"type": "string",
"description": "My new field",
"defaultValue": "Blue",
"url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
"customization": "custom"
}
Definitions
Name | Description |
---|---|
Customization |
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. |
Field |
|
Process |
Class that describes a field in a work item type and its properties. |
Update |
Class to describe a request that updates a field's properties in a work item type. |
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. |
FieldType
Name | Type | Description |
---|---|---|
boolean |
string |
Boolean field type. |
dateTime |
string |
DateTime field type. |
double |
string |
Double field type. |
guid |
string |
Guid field type. |
history |
string |
History field type. |
html |
string |
HTML (Multiline) field type. |
identity |
string |
Identity field type. |
integer |
string |
Integer field type. |
picklistDouble |
string |
Double picklist field type. |
picklistInteger |
string |
Integer picklist field type. |
picklistString |
string |
String picklist field type. |
plainText |
string |
Plain text field type. |
string |
string |
String field type. |
treePath |
string |
Treepath field type. |
ProcessWorkItemTypeField
Class that describes a field in a work item type and its properties.
Name | Type | Description |
---|---|---|
allowGroups |
boolean |
Allow setting field value to a group identity. Only applies to identity fields. |
allowedValues |
object[] |
The list of field allowed values. |
customization |
Indicates the type of customization on this work item. |
|
defaultValue |
object |
The default value of the field. |
description |
string |
Description of the field. |
isLocked |
boolean |
Information about field definition being locked for editing |
name |
string |
Name of the field. |
readOnly |
boolean |
If true the field cannot be edited. |
referenceName |
string |
Reference name of the field. |
required |
boolean |
If true the field cannot be empty. |
type |
Type of the field. |
|
url |
string |
Resource URL of the field. |
UpdateProcessWorkItemTypeFieldRequest
Class to describe a request that updates a field's properties in a work item type.
Name | Type | Description |
---|---|---|
allowGroups |
boolean |
Allow setting field value to a group identity. Only applies to identity fields. |
allowedValues |
string[] |
The list of field allowed values. |
defaultValue |
object |
The default value of the field. |
readOnly |
boolean |
If true the field cannot be edited. |
required |
boolean |
The default value of the field. |
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for