Lists - Get

Reference

Service:: Work Item Tracking Process

API Version:: 6.0-preview.1

Returns a picklist.

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

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	Grants the ability to read work items, queries, boards, area and iterations paths, and other work item tracking related metadata. Also grants the ability to execute queries, search work items and to receive notifications about work item events via service hooks.

Examples

Get list metadata

Sample Request

HTTP

GET https://dev.azure.com/fabrikam/_apis/work/processes/lists/{listId}?api-version=6.0-preview.1

Sample Response

Status code:: 200

{
  "items": [
    "-5000",
    "0",
    "9",
    "500"
  ],
  "id": "661eb38e-6f0b-484a-bc53-27a57c2e2d50",
  "name": "picklist_114e82b7-0f7f-4918-8e8e-8a53030bda20",
  "type": "Integer",
  "isSuggested": false,
  "url": "https://dev.azure.com/fabrikam/_apis/work/processes/lists/661eb38e-6f0b-484a-bc53-27a57c2e2d50"
}

Definitions

PickList

Picklist.

Name	Type	Description
id	string	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