Work Item Icons - Get

Service:

Work Item Tracking

API Version:

7.1

Get a work item icon given the friendly name and icon color.

GET https://dev.azure.com/{organization}/_apis/wit/workitemicons/{icon}?api-version=7.1

With optional parameters:

GET https://dev.azure.com/{organization}/_apis/wit/workitemicons/{icon}?color={color}&v={v}&api-version=7.1

URI Parameters

Name	In	Required	Type	Description
icon	path	True	string	The name of the icon
organization	path		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.
color	query		string	The 6-digit hex color for the icon
v	query		integer (int32)	The version of the icon (used only for cache invalidation)

Responses

Name	Type	Description
200 OK	WorkItemIcon	successful operation Media Types: "image/svg+xml", "image/xaml+xml", "application/json"

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 work item icon

Sample request

HTTP

GET https://dev.azure.com/fabrikam/_apis/wit/workitemicons/{icon}?api-version=7.1

Sample response

Status code:

200

{
  "id": "icon_clipboard",
  "url": "https://dev.azure.com/fabrikam/_apis/wit/workItemIcons/icon_clipboard"
}

Definitions

WorkItemIcon

Object

Reference to a work item icon.

Name	Type	Description
id	string	The identifier of the icon.
url	string	The REST URL of the resource.