Work Item Types - Get
Returns a work item type definition.
GET https://dev.azure.com/{organization}/{project}/_apis/wit/workitemtypes/{type}?api-version=6.0URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
organization
|
path | True |
string |
The name of the Azure DevOps organization. |
|
project
|
path | True |
string |
Project ID or project name |
|
type
|
path | True |
string |
Work item type name |
|
api-version
|
query | True |
string |
Version of the API to use. This should be set to '6.0' to use this version of the api. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
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
Sample Request
GET https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/wit/workitemtypes/{type}?api-version=6.0
Sample Response
{
"name": "Bug",
"referenceName": "Microsoft.VSTS.WorkItemTypes.Bug",
"description": "Describes a divergence between required and actual behavior, and tracks the work done to correct the defect and verify the correction.",
"color": "CC293D",
"icon": {
"id": "icon_insect",
"url": "https://dev.azure.com/fabrikam/_apis/wit/workItemIcons/icon_insect?color=CC293D&v=2"
},
"isDisabled": false,
"xmlForm": "<FORM><Layout HideReadOnlyEmptyFields=\"true\" HideControlBorders=\"true\"><Group Margin=\"(10,0,0,0)\"><Column PercentWidth=\"94\"><Control Label=\"\" LabelPosition=\"Top\" FieldName=\"System.Title\" Type=\"FieldControl\" EmptyText=\"Enter title here\" ControlFontSize=\"large\" /></Column><Column PercentWidth=\"6\"><Control Label=\"\" LabelPosition=\"Top\" FieldName=\"System.Id\" Type=\"FieldControl\" ControlFontSize=\"large\" /></Column></Group><Group Margin=\"(10,10,0,0)\"><Column PercentWidth=\"30\"><Control Label=\"Assi&gned To\" LabelPosition=\"Left\" FieldName=\"System.AssignedTo\" Type=\"FieldControl\" EmptyText=\"Unassigned\" /><Control Label=\"Stat&e\" LabelPosition=\"Left\" FieldName=\"System.State\" Type=\"FieldControl\" /><Control Label=\"Reason\" LabelPosition=\"Left\" FieldName=\"System.Reason\" Type=\"FieldControl\" /></Column><Column PercentWidth=\"40\"><Control Label=\"\" LabelPosition=\"Top\" Type=\"LabelControl\" /><Control Label=\"&Area\" LabelPosition=\"Left\" FieldName=\"System.AreaPath\" Type=\"WorkItemClassificationControl\" /><Control Label=\"Ite&ration\" LabelPosition=\"Left\" FieldName=\"System.IterationPath\" Type=\"WorkItemClassificationControl\" /></Column><Column PercentWidth=\"30\"><Control Label=\"\" LabelPosition=\"Top\" Name=\"2\" Type=\"LabelControl\" /><Control Label=\"\" LabelPosition=\"Top\" Name=\"3\" Type=\"LabelControl\" /><Control Label=\"Last Updated Date\" LabelPosition=\"Left\" FieldName=\"System.ChangedDate\" Type=\"DateTimeControl\" ReadOnly=\"True\" /></Column></Group><TabGroup Margin=\"(0,10,0,0)\"><Tab Label=\"Details\"><Group><Column PercentWidth=\"50\"><Group><Column PercentWidth=\"100\"><Group Label=\"Repro Steps\"><Column PercentWidth=\"100\"><Control Label=\"\" LabelPosition=\"Top\" FieldName=\"Microsoft.VSTS.TCM.ReproSteps\" Type=\"HtmlFieldControl\" Margin=\"(0,0,0,10)\" /></Column></Group><Group Label=\"System Info\"><Column PercentWidth=\"100\"><Control Label=\"\" LabelPosition=\"Top\" FieldName=\"Microsoft.VSTS.TCM.SystemInfo\" Type=\"HtmlFieldControl\" Margin=\"(0,0,0,10)\" /></Column></Group></Column></Group></Column><Column PercentWidth=\"50\"><Group Margin=\"(20,0,0,0)\"><Column PercentWidth=\"25\"><Group><Column PercentWidth=\"100\"><Group Label=\"Planning\"><Column PercentWidth=\"100\"><Control Label=\"Resolved Reason\" LabelPosition=\"Top\" FieldName=\"Microsoft.VSTS.Common.ResolvedReason\" Type=\"FieldControl\" Margin=\"(0,0,0,10)\" /><Control Label=\"Story Points\" LabelPosition=\"Top\" FieldName=\"Microsoft.VSTS.Scheduling.StoryPoints\" Type=\"FieldControl\" Margin=\"(0,0,0,10)\" /><Control Label=\"Priority\" LabelPosition=\"Top\" FieldName=\"Microsoft.VSTS.Common.Priority\" Type=\"FieldControl\" Margin=\"(0,0,0,10)\" /><Control Label=\"Severity\" LabelPosition=\"Top\" FieldName=\"Microsoft.VSTS.Common.Severity\" Type=\"FieldControl\" Margin=\"(0,0,0,10)\" /><Control Label=\"Activity\" LabelPosition=\"Top\" FieldName=\"Microsoft.VSTS.Common.Activity\" Type=\"FieldControl\" Margin=\"(0,0,0,10)\" /></Column></Group><Group Label=\"Effort (Hours)\"><Column PercentWidth=\"100\"><Control Label=\"Original Estimate\" LabelPosition=\"Top\" FieldName=\"Microsoft.VSTS.Scheduling.OriginalEstimate\" Type=\"FieldControl\" Margin=\"(0,0,0,10)\" /><Control Label=\"Remaining\" LabelPosition=\"Top\" FieldName=\"Microsoft.VSTS.Scheduling.RemainingWork\" Type=\"FieldControl\" Margin=\"(0,0,0,10)\" /><Control Label=\"Completed\" LabelPosition=\"Top\" FieldName=\"Microsoft.VSTS.Scheduling.CompletedWork\" Type=\"FieldControl\" Margin=\"(0,0,0,10)\" /></Column></Group></Column></Group></Column><Column PercentWidth=\"25\"><Group><Column PercentWidth=\"100\"><Group Label=\"Development\"><Column PercentWidth=\"100\"><Control Label=\"\" LabelPosition=\"Top\" FieldName=\"Development\" Type=\"LinksControl\" Margin=\"(0,0,0,10)\"><LinksControlOptions><WorkItemLinkFilters FilterType=\"excludeAll\" /><ExternalLinkFilters FilterType=\"include\"><Filter LinkType=\"Build\" /><Filter LinkType=\"Integrated in build\" /><Filter LinkType=\"Pull Request\" /><Filter LinkType=\"Branch\" /><Filter LinkType=\"Fixed in Commit\" /><Filter LinkType=\"Fixed in Changeset\" /><Filter LinkType=\"Source Code File\" /><Filter LinkType=\"Found in build\" /></ExternalLinkFilters><LinkColumns><LinkColumn RefName=\"System.Id\" /><LinkColumn RefName=\"System.Title\" /><LinkColumn LinkAttribute=\"System.Links.Comment\" /></LinkColumns></LinksControlOptions></Control></Column></Group><Group Label=\"Related Work\"><Column PercentWidth=\"100\"><Control Label=\"\" LabelPosition=\"Top\" FieldName=\"Related Work\" Type=\"LinksControl\" Margin=\"(0,0,0,10)\"><LinksControlOptions><WorkItemLinkFilters FilterType=\"include\"><Filter LinkType=\"System.LinkTypes.Duplicate\" /><Filter LinkType=\"System.LinkTypes.Hierarchy\" /><Filter LinkType=\"Microsoft.VSTS.Common.TestedBy\" /><Filter LinkType=\"System.LinkTypes.Dependency\" /><Filter LinkType=\"System.LinkTypes.Related\" /></WorkItemLinkFilters><ExternalLinkFilters FilterType=\"excludeAll\" /><LinkColumns><LinkColumn RefName=\"System.Id\" /><LinkColumn RefName=\"System.Title\" /><LinkColumn RefName=\"System.AssignedTo\" /><LinkColumn RefName=\"System.WorkItemType\" /><LinkColumn RefName=\"System.State\" /><LinkColumn RefName=\"System.ChangedDate\" /><LinkColumn LinkAttribute=\"System.Links.Comment\" /></LinkColumns></LinksControlOptions></Control></Column></Group><Group Label=\"System Info\"><Column PercentWidth=\"100\"><Control Label=\"Found in Build\" LabelPosition=\"Top\" FieldName=\"Microsoft.VSTS.Build.FoundIn\" Type=\"FieldControl\" Margin=\"(0,0,0,10)\" /><Control Label=\"Integrated in Build\" LabelPosition=\"Top\" FieldName=\"Microsoft.VSTS.Build.IntegrationBuild\" Type=\"FieldControl\" Margin=\"(0,0,0,10)\" /></Column></Group></Column></Group></Column></Group></Column></Group></Tab><Tab Label=\"History\"><Group><Column PercentWidth=\"100\"><Group><Column PercentWidth=\"100\"><Group><Column PercentWidth=\"100\"><Control Label=\"\" LabelPosition=\"Top\" FieldName=\"System.History\" Type=\"WorkItemLogControl\" Margin=\"(0,0,0,10)\" /></Column></Group></Column></Group></Column></Group></Tab><Tab Label=\"Links\"><Group><Column PercentWidth=\"100\"><Group><Column PercentWidth=\"100\"><Group><Column PercentWidth=\"100\"><Control Label=\"\" LabelPosition=\"Top\" Type=\"LinksControl\" Margin=\"(0,0,0,10)\"><LinksControlOptions><LinkColumns><LinkColumn RefName=\"System.Id\" /><LinkColumn RefName=\"System.Title\" /><LinkColumn RefName=\"System.AssignedTo\" /><LinkColumn RefName=\"System.WorkItemType\" /><LinkColumn RefName=\"System.State\" /><LinkColumn RefName=\"System.ChangedDate\" /><LinkColumn LinkAttribute=\"System.Links.Comment\" /></LinkColumns></LinksControlOptions></Control></Column></Group></Column></Group></Column></Group></Tab><Tab Label=\"Attachments\"><Group><Column PercentWidth=\"100\"><Group><Column PercentWidth=\"100\"><Group><Column PercentWidth=\"100\"><Control Label=\"Attachments\" LabelPosition=\"Top\" Type=\"AttachmentsControl\" Margin=\"(0,0,0,10)\" /></Column></Group></Column></Group></Column></Group></Tab></TabGroup></Layout></FORM>",
"fields": [
{
"helpText": "The iteration within which this bug will be fixed",
"alwaysRequired": false,
"referenceName": "System.IterationPath",
"name": "Iteration Path",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": true,
"referenceName": "System.IterationId",
"name": "Iteration ID",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.ExternalLinkCount",
"name": "External Link Count",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.TeamProject",
"name": "Team Project",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.HyperLinkCount",
"name": "Hyperlink Count",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.AttachedFileCount",
"name": "Attached File Count",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.NodeName",
"name": "Node Name",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"helpText": "The area of the product with which this bug is associated",
"alwaysRequired": false,
"referenceName": "System.AreaPath",
"name": "Area Path",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.RevisedDate",
"name": "Revised Date",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.ChangedDate",
"name": "Changed Date",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.Id",
"name": "ID",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": true,
"referenceName": "System.AreaId",
"name": "Area ID",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.AuthorizedAs",
"name": "Authorized As",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"helpText": "Stories affected and how",
"alwaysRequired": true,
"referenceName": "System.Title",
"name": "Title",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"helpText": "New = for triage; Active = not yet fixed; Resolved = fixed not yet verified; Closed = fix verified.",
"alwaysRequired": true,
"referenceName": "System.State",
"name": "State",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.AuthorizedDate",
"name": "Authorized Date",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.Watermark",
"name": "Watermark",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.Rev",
"name": "Rev",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.ChangedBy",
"name": "Changed By",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"helpText": "The reason why the bug is in the current state",
"alwaysRequired": false,
"referenceName": "System.Reason",
"name": "Reason",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"helpText": "The person currently working on this bug",
"alwaysRequired": false,
"referenceName": "System.AssignedTo",
"name": "Assigned To",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.WorkItemType",
"name": "Work Item Type",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.CreatedDate",
"name": "Created Date",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.CreatedBy",
"name": "Created By",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.Description",
"name": "Description",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"helpText": "Discussion thread plus automatic record of changes",
"alwaysRequired": false,
"referenceName": "System.History",
"name": "History",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.RelatedLinkCount",
"name": "Related Link Count",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.Tags",
"name": "Tags",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.BoardColumn",
"name": "Board Column",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.BoardColumnDone",
"name": "Board Column Done",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.BoardLane",
"name": "Board Lane",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"helpText": "The size of work estimated for fixing the bug",
"alwaysRequired": false,
"referenceName": "Microsoft.VSTS.Scheduling.StoryPoints",
"name": "Story Points",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"helpText": "An estimate of the number of units of work remaining to complete this bug",
"alwaysRequired": false,
"referenceName": "Microsoft.VSTS.Scheduling.RemainingWork",
"name": "Remaining Work",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"helpText": "Initial value for Remaining Work - set once, when work begins",
"alwaysRequired": false,
"referenceName": "Microsoft.VSTS.Scheduling.OriginalEstimate",
"name": "Original Estimate",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"helpText": "The number of units of work that have been spent on this bug",
"alwaysRequired": false,
"referenceName": "Microsoft.VSTS.Scheduling.CompletedWork",
"name": "Completed Work",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"helpText": "Type of work involved",
"alwaysRequired": false,
"referenceName": "Microsoft.VSTS.Common.Activity",
"name": "Activity",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"helpText": "Test context, provided automatically by test infrastructure",
"alwaysRequired": false,
"referenceName": "Microsoft.VSTS.TCM.SystemInfo",
"name": "System Info",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"helpText": "How to see the bug. End by contrasting expected with actual behavior.",
"alwaysRequired": false,
"referenceName": "Microsoft.VSTS.TCM.ReproSteps",
"name": "Repro Steps",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "Microsoft.VSTS.Common.StateChangeDate",
"name": "State Change Date",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "Microsoft.VSTS.Common.ActivatedDate",
"name": "Activated Date",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "Microsoft.VSTS.Common.ActivatedBy",
"name": "Activated By",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "Microsoft.VSTS.Common.ResolvedDate",
"name": "Resolved Date",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "Microsoft.VSTS.Common.ResolvedBy",
"name": "Resolved By",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"helpText": "The reason why the bug was resolved",
"alwaysRequired": false,
"referenceName": "Microsoft.VSTS.Common.ResolvedReason",
"name": "Resolved Reason",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "Microsoft.VSTS.Common.ClosedDate",
"name": "Closed Date",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "Microsoft.VSTS.Common.ClosedBy",
"name": "Closed By",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"helpText": "Business importance. 1=must fix; 4=unimportant.",
"alwaysRequired": false,
"referenceName": "Microsoft.VSTS.Common.Priority",
"name": "Priority",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"helpText": "Assessment of the effect of the bug on the project",
"alwaysRequired": false,
"referenceName": "Microsoft.VSTS.Common.Severity",
"name": "Severity",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"helpText": "Work first on items with lower-valued stack rank. Set in triage.",
"alwaysRequired": false,
"referenceName": "Microsoft.VSTS.Common.StackRank",
"name": "Stack Rank",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"helpText": "The type should be set to Business primarily to represent customer-facing issues. Work to change the architecture should be added as a User Story",
"alwaysRequired": true,
"referenceName": "Microsoft.VSTS.Common.ValueArea",
"name": "Value Area",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"helpText": "The build in which the bug was fixed",
"alwaysRequired": false,
"referenceName": "Microsoft.VSTS.Build.IntegrationBuild",
"name": "Integration Build",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"helpText": "The build in which the bug was found",
"alwaysRequired": false,
"referenceName": "Microsoft.VSTS.Build.FoundIn",
"name": "Found In",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.AttachedFiles",
"name": "Attached Files",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.RelatedLinks",
"name": "Related Links",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.LinkedFiles",
"name": "Linked Files",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.BISLinks",
"name": "BIS Links",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
}
],
"fieldInstances": [
{
"helpText": "The iteration within which this bug will be fixed",
"alwaysRequired": false,
"referenceName": "System.IterationPath",
"name": "Iteration Path",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": true,
"referenceName": "System.IterationId",
"name": "Iteration ID",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.ExternalLinkCount",
"name": "External Link Count",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.TeamProject",
"name": "Team Project",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.HyperLinkCount",
"name": "Hyperlink Count",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.AttachedFileCount",
"name": "Attached File Count",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.NodeName",
"name": "Node Name",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"helpText": "The area of the product with which this bug is associated",
"alwaysRequired": false,
"referenceName": "System.AreaPath",
"name": "Area Path",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.RevisedDate",
"name": "Revised Date",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.ChangedDate",
"name": "Changed Date",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.Id",
"name": "ID",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": true,
"referenceName": "System.AreaId",
"name": "Area ID",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.AuthorizedAs",
"name": "Authorized As",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"helpText": "Stories affected and how",
"alwaysRequired": true,
"referenceName": "System.Title",
"name": "Title",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"helpText": "New = for triage; Active = not yet fixed; Resolved = fixed not yet verified; Closed = fix verified.",
"alwaysRequired": true,
"referenceName": "System.State",
"name": "State",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.AuthorizedDate",
"name": "Authorized Date",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.Watermark",
"name": "Watermark",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.Rev",
"name": "Rev",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.ChangedBy",
"name": "Changed By",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"helpText": "The reason why the bug is in the current state",
"alwaysRequired": false,
"referenceName": "System.Reason",
"name": "Reason",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"helpText": "The person currently working on this bug",
"alwaysRequired": false,
"referenceName": "System.AssignedTo",
"name": "Assigned To",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.WorkItemType",
"name": "Work Item Type",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.CreatedDate",
"name": "Created Date",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.CreatedBy",
"name": "Created By",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.Description",
"name": "Description",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"helpText": "Discussion thread plus automatic record of changes",
"alwaysRequired": false,
"referenceName": "System.History",
"name": "History",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.RelatedLinkCount",
"name": "Related Link Count",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.Tags",
"name": "Tags",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.BoardColumn",
"name": "Board Column",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.BoardColumnDone",
"name": "Board Column Done",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.BoardLane",
"name": "Board Lane",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"helpText": "The size of work estimated for fixing the bug",
"alwaysRequired": false,
"referenceName": "Microsoft.VSTS.Scheduling.StoryPoints",
"name": "Story Points",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"helpText": "An estimate of the number of units of work remaining to complete this bug",
"alwaysRequired": false,
"referenceName": "Microsoft.VSTS.Scheduling.RemainingWork",
"name": "Remaining Work",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"helpText": "Initial value for Remaining Work - set once, when work begins",
"alwaysRequired": false,
"referenceName": "Microsoft.VSTS.Scheduling.OriginalEstimate",
"name": "Original Estimate",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"helpText": "The number of units of work that have been spent on this bug",
"alwaysRequired": false,
"referenceName": "Microsoft.VSTS.Scheduling.CompletedWork",
"name": "Completed Work",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"helpText": "Type of work involved",
"alwaysRequired": false,
"referenceName": "Microsoft.VSTS.Common.Activity",
"name": "Activity",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"helpText": "Test context, provided automatically by test infrastructure",
"alwaysRequired": false,
"referenceName": "Microsoft.VSTS.TCM.SystemInfo",
"name": "System Info",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"helpText": "How to see the bug. End by contrasting expected with actual behavior.",
"alwaysRequired": false,
"referenceName": "Microsoft.VSTS.TCM.ReproSteps",
"name": "Repro Steps",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "Microsoft.VSTS.Common.StateChangeDate",
"name": "State Change Date",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "Microsoft.VSTS.Common.ActivatedDate",
"name": "Activated Date",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "Microsoft.VSTS.Common.ActivatedBy",
"name": "Activated By",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "Microsoft.VSTS.Common.ResolvedDate",
"name": "Resolved Date",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "Microsoft.VSTS.Common.ResolvedBy",
"name": "Resolved By",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"helpText": "The reason why the bug was resolved",
"alwaysRequired": false,
"referenceName": "Microsoft.VSTS.Common.ResolvedReason",
"name": "Resolved Reason",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "Microsoft.VSTS.Common.ClosedDate",
"name": "Closed Date",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "Microsoft.VSTS.Common.ClosedBy",
"name": "Closed By",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"helpText": "Business importance. 1=must fix; 4=unimportant.",
"alwaysRequired": false,
"referenceName": "Microsoft.VSTS.Common.Priority",
"name": "Priority",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"helpText": "Assessment of the effect of the bug on the project",
"alwaysRequired": false,
"referenceName": "Microsoft.VSTS.Common.Severity",
"name": "Severity",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"helpText": "Work first on items with lower-valued stack rank. Set in triage.",
"alwaysRequired": false,
"referenceName": "Microsoft.VSTS.Common.StackRank",
"name": "Stack Rank",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"helpText": "The type should be set to Business primarily to represent customer-facing issues. Work to change the architecture should be added as a User Story",
"alwaysRequired": true,
"referenceName": "Microsoft.VSTS.Common.ValueArea",
"name": "Value Area",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"helpText": "The build in which the bug was fixed",
"alwaysRequired": false,
"referenceName": "Microsoft.VSTS.Build.IntegrationBuild",
"name": "Integration Build",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"helpText": "The build in which the bug was found",
"alwaysRequired": false,
"referenceName": "Microsoft.VSTS.Build.FoundIn",
"name": "Found In",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.AttachedFiles",
"name": "Attached Files",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.RelatedLinks",
"name": "Related Links",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.LinkedFiles",
"name": "Linked Files",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
},
{
"alwaysRequired": false,
"referenceName": "System.BISLinks",
"name": "BIS Links",
"url": "https://dev.azure.com/fabrikam/_apis/wit/fields"
}
],
"transitions": {
"Active": [
{
"to": "Active",
"actions": null
},
{
"to": "Closed",
"actions": null
},
{
"to": "Resolved",
"actions": [
"Microsoft.VSTS.Actions.Checkin"
]
},
{
"to": "New",
"actions": [
"Microsoft.VSTS.Actions.StopWork"
]
}
],
"Closed": [
{
"to": "Closed",
"actions": null
},
{
"to": "Resolved",
"actions": null
},
{
"to": "Active",
"actions": null
},
{
"to": "New",
"actions": null
}
],
"New": [
{
"to": "New",
"actions": null
},
{
"to": "Closed",
"actions": null
},
{
"to": "Resolved",
"actions": [
"Microsoft.VSTS.Actions.Checkin"
]
},
{
"to": "Active",
"actions": [
"Microsoft.VSTS.Actions.StartWork"
]
}
],
"Resolved": [
{
"to": "Resolved",
"actions": null
},
{
"to": "Closed",
"actions": null
},
{
"to": "Active",
"actions": null
},
{
"to": "New",
"actions": null
}
],
"": [
{
"to": "New",
"actions": null
}
]
},
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/66ebcf8f-1006-4819-be8b-d420d9ecb202/_apis/wit/workItemTypes/Bug"
}
},
"url": "https://dev.azure.com/fabrikam/66ebcf8f-1006-4819-be8b-d420d9ecb202/_apis/wit/workItemTypes/Bug"
}Definitions
| Name | Description |
|---|---|
|
Reference |
The class to represent a collection of REST reference links. |
|
Work |
Reference to a field in a work item |
|
Work |
Reference to a work item icon. |
|
Work |
Work item type state name, color and state category |
|
Work |
Describes a work item type. |
|
Work |
Field instance of a work item type. |
ReferenceLinks
The class to represent a collection of REST reference links.
| Name | Type | Description |
|---|---|---|
| links |
object |
The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only. |
WorkItemFieldReference
Reference to a field in a work item
| Name | Type | Description |
|---|---|---|
| name |
string |
The friendly name of the field. |
| referenceName |
string |
The reference name of the field. |
| url |
string |
The REST URL of the resource. |
WorkItemIcon
Reference to a work item icon.
| Name | Type | Description |
|---|---|---|
| id |
string |
The identifier of the icon. |
| url |
string |
The REST URL of the resource. |
WorkItemStateColor
Work item type state name, color and state category
| Name | Type | Description |
|---|---|---|
| category |
string |
Category of state |
| color |
string |
Color value |
| name |
string |
Work item type state name |
WorkItemType
Describes a work item type.
| Name | Type | Description |
|---|---|---|
| _links |
Link references to related REST resources. |
|
| color |
string |
The color. |
| description |
string |
The description of the work item type. |
| fieldInstances |
The fields that exist on the work item type. |
|
| fields |
The fields that exist on the work item type. |
|
| icon |
The icon of the work item type. |
|
| isDisabled |
boolean |
True if work item type is disabled |
| name |
string |
Gets the name of the work item type. |
| referenceName |
string |
The reference name of the work item type. |
| states |
Gets state information for the work item type. |
|
| transitions |
object |
Gets the various state transition mappings in the work item type. |
| url |
string |
|
| xmlForm |
string |
The XML form. |
WorkItemTypeFieldInstance
Field instance of a work item type.
| Name | Type | Description |
|---|---|---|
| allowedValues |
string[] |
The list of field allowed values. |
| alwaysRequired |
boolean |
Indicates whether field value is always required. |
| defaultValue |
string |
Represents the default value of the field. |
| dependentFields |
The list of dependent fields. |
|
| helpText |
string |
Gets the help text for the field. |
| name |
string |
The friendly name of the field. |
| referenceName |
string |
The reference name of the field. |
| url |
string |
The REST URL of the resource. |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for