Lists - Update

Service:

Work Item Tracking Process Definitions

API Version:

4.1-preview.1

Updates a list.

PUT https://dev.azure.com/{organization}/_apis/work/processdefinitions/lists/{listId}?api-version=4.1-preview.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 '4.1-preview.1' to use this version of the api.

Request Body

Name	Type	Description
id	string	ID of the picklist
isSuggested	boolean	Is input values by user only limited to suggested values
items	PickListItemModel[]	A list of PicklistItemModel
name	string	Name of the picklist
type	string	Type of picklist
url	string	Url of the picklist

Responses

Name	Type	Description
200 OK	PickListModel	successful operation

Security

accessToken

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

Type: basic

Examples

Update the picklist

Sample Request

HTTP

PUT https://dev.azure.com/{organization}/_apis/work/processdefinitions/lists/{listId}?api-version=4.1-preview.1

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

Sample Response

Status code:

200

{
  "items": [
    {
      "id": "2cda65f2-ae16-4252-8639-70723fc62555",
      "value": "Blue"
    },
    {
      "id": "730b5295-d841-4ff3-94c3-a83777514174",
      "value": "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/processDefinitions/lists/a07a079a-c79e-4221-9436-a9d732a8a4d0"
}

Definitions

Name	Description
PickListItemModel
PickListModel

PickListItemModel

Name	Type	Description
id	string
value	string

PickListModel

Name	Type	Description
id	string	ID of the picklist
isSuggested	boolean	Is input values by user only limited to suggested values
items	PickListItemModel[]	A list of PicklistItemModel
name	string	Name of the picklist
type	string	Type of picklist
url	string	Url of the picklist