Lists - List

Service:: Work Item Tracking Process

API Version:: 7.1

Returns meta data of the picklist.

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

URI Parameters

Name	In	Required	Type	Description
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.

Responses

Name	Type	Description
200 OK	PickListMetadata[]	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 lists metadata

Sample request

HTTP

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

Sample response

Status code:: 200

{
  "count": 5,
  "value": [
    {
      "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"
    },
    {
      "id": "84c4a4e2-18ce-4a73-95c6-92a614c87fac",
      "name": "picklist_10b1970f-61ff-4f05-ad60-839f69aa236e",
      "type": "Integer",
      "isSuggested": false,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processes/lists/84c4a4e2-18ce-4a73-95c6-92a614c87fac"
    },
    {
      "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"
    },
    {
      "id": "faca4495-a78a-4f0c-81c7-d26cd693e213",
      "name": "picklist_c3fd545b-4be0-42a2-becd-f5889249ef99",
      "type": "String",
      "isSuggested": false,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processes/lists/faca4495-a78a-4f0c-81c7-d26cd693e213"
    },
    {
      "id": "3dc397de-087e-4877-b071-d3dbef86f294",
      "name": "picklist_99af9252-f401-4f6d-bc88-0a88c5f7e347",
      "type": "String",
      "isSuggested": false,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processes/lists/3dc397de-087e-4877-b071-d3dbef86f294"
    }
  ]
}

Definitions

PickListMetadata

Object

Metadata for picklist.

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

Share via