Work item tracking work item icons

Last Update: 9/1/2017

api-version = 4-1-preview

If you haven't already, look at the information on getting started with these APIs.

Discover the list of work item icons and view individual icons.

List

Get a list of all work item icons.

GET https://{instance}/_apis/wit/workitemicons?api-version={version}

Request parameters

Name In Type Notes
api-version Query string Required. Version of the API to use. This should be set to '4.1-preview' to use this version of the API.

Response

Type Notes
VssJsonCollectionWrapper<array (WorkItemIcon)> Work item icons

Sample request

GET https://fabrikam-fiber-inc.visualstudio.com/_apis/wit/workItemIcons

Sample response

Status code: 200
{
  "count": 41,
  "value": [
    {
      "id": "icon_clipboard",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/_apis/wit/workItemIcons/icon_clipboard?v=2"
    },
    {
      "id": "icon_crown",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/_apis/wit/workItemIcons/icon_crown?v=2"
    },
    {
      "id": "icon_trophy",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/_apis/wit/workItemIcons/icon_trophy?v=2"
    },
    {
      "id": "icon_list",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/_apis/wit/workItemIcons/icon_list?v=2"
    },
    {
      "id": "icon_book",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/_apis/wit/workItemIcons/icon_book?v=2"
    },
    {
      "id": "icon_sticky_note",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/_apis/wit/workItemIcons/icon_sticky_note?v=2"
    },
    {
      "id": "icon_insect",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/_apis/wit/workItemIcons/icon_insect?v=2"
    },
    {
      "id": "icon_traffic_cone",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/_apis/wit/workItemIcons/icon_traffic_cone?v=2"
    },
    {
      "id": "icon_chat_bubble",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/_apis/wit/workItemIcons/icon_chat_bubble?v=2"
    },
    {
      "id": "icon_flame",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/_apis/wit/workItemIcons/icon_flame?v=2"
    },
    {
      "id": "icon_megaphone",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/_apis/wit/workItemIcons/icon_megaphone?v=2"
    },
    {
      "id": "icon_code_review",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/_apis/wit/workItemIcons/icon_code_review?v=2"
    },
    {
      "id": "icon_code_response",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/_apis/wit/workItemIcons/icon_code_response?v=2"
    },
    {
      "id": "icon_review",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/_apis/wit/workItemIcons/icon_review?v=2"
    },
    {
      "id": "icon_response",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/_apis/wit/workItemIcons/icon_response?v=2"
    },
    {
      "id": "icon_test_plan",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/_apis/wit/workItemIcons/icon_test_plan?v=2"
    },
    {
      "id": "icon_test_suite",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/_apis/wit/workItemIcons/icon_test_suite?v=2"
    },
    {
      "id": "icon_test_case",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/_apis/wit/workItemIcons/icon_test_case?v=2"
    },
    {
      "id": "icon_test_step",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/_apis/wit/workItemIcons/icon_test_step?v=2"
    },
    {
      "id": "icon_test_parameter",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/_apis/wit/workItemIcons/icon_test_parameter?v=2"
    },
    {
      "id": "icon_star",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/_apis/wit/workItemIcons/icon_star?v=2"
    },
    {
      "id": "icon_ribbon",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/_apis/wit/workItemIcons/icon_ribbon?v=2"
    },
    {
      "id": "icon_chart",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/_apis/wit/workItemIcons/icon_chart?v=2"
    },
    {
      "id": "icon_headphone",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/_apis/wit/workItemIcons/icon_headphone?v=2"
    },
    {
      "id": "icon_key",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/_apis/wit/workItemIcons/icon_key?v=2"
    },
    {
      "id": "icon_airplane",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/_apis/wit/workItemIcons/icon_airplane?v=2"
    },
    {
      "id": "icon_car",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/_apis/wit/workItemIcons/icon_car?v=2"
    },
    {
      "id": "icon_diamond",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/_apis/wit/workItemIcons/icon_diamond?v=2"
    },
    {
      "id": "icon_asterisk",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/_apis/wit/workItemIcons/icon_asterisk?v=2"
    },
    {
      "id": "icon_database_storage",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/_apis/wit/workItemIcons/icon_database_storage?v=2"
    },
    {
      "id": "icon_government",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/_apis/wit/workItemIcons/icon_government?v=2"
    },
    {
      "id": "icon_gavel",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/_apis/wit/workItemIcons/icon_gavel?v=2"
    },
    {
      "id": "icon_parachute",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/_apis/wit/workItemIcons/icon_parachute?v=2"
    },
    {
      "id": "icon_paint_brush",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/_apis/wit/workItemIcons/icon_paint_brush?v=2"
    },
    {
      "id": "icon_palette",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/_apis/wit/workItemIcons/icon_palette?v=2"
    },
    {
      "id": "icon_gear",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/_apis/wit/workItemIcons/icon_gear?v=2"
    },
    {
      "id": "icon_check_box",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/_apis/wit/workItemIcons/icon_check_box?v=2"
    },
    {
      "id": "icon_gift",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/_apis/wit/workItemIcons/icon_gift?v=2"
    },
    {
      "id": "icon_test_beaker",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/_apis/wit/workItemIcons/icon_test_beaker?v=2"
    },
    {
      "id": "icon_broken_lightbulb",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/_apis/wit/workItemIcons/icon_broken_lightbulb?v=2"
    },
    {
      "id": "icon_clipboard_issue",
      "url": "https://fabrikam-fiber-inc.visualstudio.com/_apis/wit/workItemIcons/icon_clipboard_issue?v=2"
    }
  ]
}

Get work item icon json

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

GET https://{instance}/_apis/wit/workitemicons/{icon}?api-version={version}

Request parameters

Name In Type Notes
icon URL string Required. The name of the icon
api-version Query string Required. Version of the API to use. This should be set to '4.1-preview' to use this version of the API.
color Query string Optional. The 6-digit hex color for the icon

Response

Type Notes
WorkItemIcon Icon as SVG or JSON Media Types: "image/svg+xml", "application/json"

Get work item icon svg

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

GET https://{instance}/_apis/wit/workitemicons/{icon}?api-version={version}

Request parameters

Name In Type Notes
icon URL string Required. The name of the icon
api-version Query string Required. Version of the API to use. This should be set to '4.1-preview' to use this version of the API.
color Query string Optional. The 6-digit hex color for the icon

Response

Type Notes
Stream Icon as SVG or JSON Media Type: "image/svg+xml"