Lists - Update

Service:: Work Item Tracking Process

API Version:: 7.1

Updates a list.

PUT https://dev.azure.com/{organization}/_apis/work/processes/lists/{listId}?api-version=7.1

URI Parameters

Name	In	Required	Type	Description
listId	path	True	string (uuid)	The ID of the list
organization	path	True	string	The name of the Azure DevOps organization.
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
id	string (uuid)	ID of the picklist
isSuggested	boolean	Indicates whether items outside of suggested list are allowed
items	string[]	A list of PicklistItemModel.
name	string	Name of the picklist
type	string	DataType of picklist
url	string	Url of the picklist

Responses

Name	Type	Description
200 OK	PickList	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

Update the picklist

Sample request

HTTP

PUT https://dev.azure.com/{organization}/_apis/work/processes/lists/{listId}?api-version=7.1

{
  "id": "a07a079a-c79e-4221-9436-a9d732a8a4d0",
  "name": null,
  "type": null,
  "items": [
    "Blue",
    "Red"
  ],
  "isSuggested": false,
  "url": null
}

Sample response

Status code:: 200

{
  "items": [
    "Blue",
    "Red"
  ],
  "id": "a07a079a-c79e-4221-9436-a9d732a8a4d0",
  "name": "picklist_aef2c045-0d2d-4f92-9d09-56eea553e1ef",
  "type": "String",
  "isSuggested": false,
  "url": "https://dev.azure.com/fabrikam/_apis/work/processes/lists/a07a079a-c79e-4221-9436-a9d732a8a4d0"
}

Definitions

PickList

Object

Picklist.

Name	Type	Description
id	string (uuid)	ID of the picklist
isSuggested	boolean	Indicates whether items outside of suggested list are allowed
items	string[]	A list of PicklistItemModel.
name	string	Name of the picklist
type	string	DataType of picklist
url	string	Url of the picklist

Share via