Share via

Fields - Get Work Item Type Fields

Service:
Work Item Tracking Process
API Version:
4.1-preview.1

Returns a list of all fields in a work item type.

GET https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/fields?api-version=4.1-preview.1

URI Parameters

Name In Required Type Description
organization
 path True

string

The name of the Azure DevOps organization.
processId
 path True

string (uuid)

The ID of the process
witRefName
 path True

string

The reference name of the work item type
api-version
 query True

string

Version of the API to use. This should be set to '4.1-preview.1' to use this version of the api.

Responses

Name Type Description
200 OK

FieldModel[]

successful operation

Security

accessToken

Personal access token. Use any value for the user name and the token as the password.

Type: basic

Examples

Get the list of work item type fields

Sample request

GET https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/fields?api-version=4.1-preview.1

Sample response

Status code:
200 
{
  "count": 52,
  "value": [
    {
      "id": "System.Id",
      "name": "Id",
      "type": "integer",
      "description": null,
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/System.Id",
      "isIdentity": false
    },
    {
      "id": "System.Title",
      "name": "Title",
      "type": "string",
      "description": "Stories affected and how",
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/System.Title",
      "isIdentity": false
    },
    {
      "id": "Microsoft.VSTS.Scheduling.StoryPoints",
      "name": "Story Points",
      "type": "double",
      "description": "The size of work estimated for fixing the bug",
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/Microsoft.VSTS.Scheduling.StoryPoints",
      "isIdentity": false
    },
    {
      "id": "Microsoft.VSTS.Scheduling.RemainingWork",
      "name": "Remaining Work",
      "type": "double",
      "description": "An estimate of the number of units of work remaining to complete this bug",
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/Microsoft.VSTS.Scheduling.RemainingWork",
      "isIdentity": false
    },
    {
      "id": "Microsoft.VSTS.Scheduling.OriginalEstimate",
      "name": "Original Estimate",
      "type": "double",
      "description": "Initial value for Remaining Work - set once, when work begins",
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/Microsoft.VSTS.Scheduling.OriginalEstimate",
      "isIdentity": false
    },
    {
      "id": "Microsoft.VSTS.Scheduling.CompletedWork",
      "name": "Completed Work",
      "type": "double",
      "description": "The number of units of work that have been spent on this bug",
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/Microsoft.VSTS.Scheduling.CompletedWork",
      "isIdentity": false
    },
    {
      "id": "Microsoft.VSTS.Common.Activity",
      "name": "Activity",
      "type": "string",
      "description": "Type of work involved",
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/Microsoft.VSTS.Common.Activity",
      "isIdentity": false
    },
    {
      "id": "Microsoft.VSTS.TCM.SystemInfo",
      "name": "System Info",
      "type": "html",
      "description": "Test context, provided automatically by test infrastructure",
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/Microsoft.VSTS.TCM.SystemInfo",
      "isIdentity": false
    },
    {
      "id": "Microsoft.VSTS.TCM.ReproSteps",
      "name": "Repro Steps",
      "type": "html",
      "description": "How to see the bug. End by contrasting expected with actual behavior.",
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/Microsoft.VSTS.TCM.ReproSteps",
      "isIdentity": false
    },
    {
      "id": "System.AssignedTo",
      "name": "Assigned To",
      "type": "string",
      "description": "The person currently working on this bug",
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/System.AssignedTo",
      "isIdentity": true
    },
    {
      "id": "System.AreaPath",
      "name": "Area Path",
      "type": "treePath",
      "description": "The area of the product with which this bug is associated",
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/System.AreaPath",
      "isIdentity": false
    },
    {
      "id": "System.IterationPath",
      "name": "Iteration Path",
      "type": "treePath",
      "description": "The iteration within which this bug will be fixed",
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/System.IterationPath",
      "isIdentity": false
    },
    {
      "id": "System.History",
      "name": "History",
      "type": "history",
      "description": "Discussion thread plus automatic record of changes",
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/System.History",
      "isIdentity": false
    },
    {
      "id": "System.State",
      "name": "State",
      "type": "string",
      "description": "New = for triage; Active = not yet fixed; Resolved = fixed not yet verified; Closed = fix verified.",
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/System.State",
      "isIdentity": false
    },
    {
      "id": "System.Reason",
      "name": "Reason",
      "type": "string",
      "description": "The reason why the bug is in the current state",
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/System.Reason",
      "isIdentity": false
    },
    {
      "id": "System.ChangedDate",
      "name": "Changed Date",
      "type": "dateTime",
      "description": null,
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/System.ChangedDate",
      "isIdentity": false
    },
    {
      "id": "System.ChangedBy",
      "name": "Changed By",
      "type": "string",
      "description": null,
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/System.ChangedBy",
      "isIdentity": true
    },
    {
      "id": "System.CreatedDate",
      "name": "Created Date",
      "type": "dateTime",
      "description": null,
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/System.CreatedDate",
      "isIdentity": false
    },
    {
      "id": "System.CreatedBy",
      "name": "Created By",
      "type": "string",
      "description": null,
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/System.CreatedBy",
      "isIdentity": true
    },
    {
      "id": "Microsoft.VSTS.Common.StateChangeDate",
      "name": "State Change Date",
      "type": "dateTime",
      "description": null,
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/Microsoft.VSTS.Common.StateChangeDate",
      "isIdentity": false
    },
    {
      "id": "Microsoft.VSTS.Common.ActivatedDate",
      "name": "Activated Date",
      "type": "dateTime",
      "description": null,
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/Microsoft.VSTS.Common.ActivatedDate",
      "isIdentity": false
    },
    {
      "id": "Microsoft.VSTS.Common.ActivatedBy",
      "name": "Activated By",
      "type": "string",
      "description": null,
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/Microsoft.VSTS.Common.ActivatedBy",
      "isIdentity": true
    },
    {
      "id": "Microsoft.VSTS.Common.ResolvedDate",
      "name": "Resolved Date",
      "type": "dateTime",
      "description": null,
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/Microsoft.VSTS.Common.ResolvedDate",
      "isIdentity": false
    },
    {
      "id": "Microsoft.VSTS.Common.ResolvedBy",
      "name": "Resolved By",
      "type": "string",
      "description": null,
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/Microsoft.VSTS.Common.ResolvedBy",
      "isIdentity": true
    },
    {
      "id": "Microsoft.VSTS.Common.ResolvedReason",
      "name": "Resolved Reason",
      "type": "string",
      "description": "The reason why the bug was resolved",
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/Microsoft.VSTS.Common.ResolvedReason",
      "isIdentity": false
    },
    {
      "id": "Microsoft.VSTS.Common.ClosedDate",
      "name": "Closed Date",
      "type": "dateTime",
      "description": null,
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/Microsoft.VSTS.Common.ClosedDate",
      "isIdentity": false
    },
    {
      "id": "Microsoft.VSTS.Common.ClosedBy",
      "name": "Closed By",
      "type": "string",
      "description": null,
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/Microsoft.VSTS.Common.ClosedBy",
      "isIdentity": true
    },
    {
      "id": "Microsoft.VSTS.Common.Priority",
      "name": "Priority",
      "type": "integer",
      "description": "Business importance. 1=must fix; 4=unimportant.",
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/Microsoft.VSTS.Common.Priority",
      "isIdentity": false
    },
    {
      "id": "Microsoft.VSTS.Common.Severity",
      "name": "Severity",
      "type": "string",
      "description": "Assessment of the effect of the bug on the project",
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/Microsoft.VSTS.Common.Severity",
      "isIdentity": false
    },
    {
      "id": "Microsoft.VSTS.Common.StackRank",
      "name": "Stack Rank",
      "type": "double",
      "description": "Work first on items with lower-valued stack rank. Set in triage.",
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/Microsoft.VSTS.Common.StackRank",
      "isIdentity": false
    },
    {
      "id": "Microsoft.VSTS.Common.ValueArea",
      "name": "Value Area",
      "type": "string",
      "description": "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",
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/Microsoft.VSTS.Common.ValueArea",
      "isIdentity": false
    },
    {
      "id": "Microsoft.VSTS.Build.IntegrationBuild",
      "name": "Integration Build",
      "type": "string",
      "description": "The build in which the bug was fixed",
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/Microsoft.VSTS.Build.IntegrationBuild",
      "isIdentity": false
    },
    {
      "id": "Microsoft.VSTS.Build.FoundIn",
      "name": "Found In",
      "type": "string",
      "description": "The build in which the bug was found",
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/Microsoft.VSTS.Build.FoundIn",
      "isIdentity": false
    },
    {
      "id": "System.IterationId",
      "name": "Iteration ID",
      "type": "integer",
      "description": null,
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/System.IterationId",
      "isIdentity": false
    },
    {
      "id": "System.ExternalLinkCount",
      "name": "External Link Count",
      "type": "integer",
      "description": null,
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/System.ExternalLinkCount",
      "isIdentity": false
    },
    {
      "id": "System.TeamProject",
      "name": "Team Project",
      "type": "string",
      "description": null,
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/System.TeamProject",
      "isIdentity": false
    },
    {
      "id": "System.HyperLinkCount",
      "name": "Hyperlink Count",
      "type": "integer",
      "description": null,
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/System.HyperLinkCount",
      "isIdentity": false
    },
    {
      "id": "System.AttachedFileCount",
      "name": "Attached File Count",
      "type": "integer",
      "description": null,
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/System.AttachedFileCount",
      "isIdentity": false
    },
    {
      "id": "System.NodeName",
      "name": "Node Name",
      "type": "string",
      "description": null,
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/System.NodeName",
      "isIdentity": false
    },
    {
      "id": "System.RevisedDate",
      "name": "Revised Date",
      "type": "dateTime",
      "description": null,
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/System.RevisedDate",
      "isIdentity": false
    },
    {
      "id": "System.AreaId",
      "name": "Area ID",
      "type": "integer",
      "description": null,
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/System.AreaId",
      "isIdentity": false
    },
    {
      "id": "System.AuthorizedAs",
      "name": "Authorized As",
      "type": "string",
      "description": null,
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/System.AuthorizedAs",
      "isIdentity": false
    },
    {
      "id": "System.AuthorizedDate",
      "name": "Authorized Date",
      "type": "dateTime",
      "description": null,
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/System.AuthorizedDate",
      "isIdentity": false
    },
    {
      "id": "System.Watermark",
      "name": "Watermark",
      "type": "integer",
      "description": null,
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/System.Watermark",
      "isIdentity": false
    },
    {
      "id": "System.Rev",
      "name": "Rev",
      "type": "integer",
      "description": null,
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/System.Rev",
      "isIdentity": false
    },
    {
      "id": "System.WorkItemType",
      "name": "Work Item Type",
      "type": "string",
      "description": null,
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/System.WorkItemType",
      "isIdentity": false
    },
    {
      "id": "System.Description",
      "name": "Description",
      "type": "html",
      "description": null,
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/System.Description",
      "isIdentity": false
    },
    {
      "id": "System.RelatedLinkCount",
      "name": "Related Link Count",
      "type": "integer",
      "description": null,
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/System.RelatedLinkCount",
      "isIdentity": false
    },
    {
      "id": "System.Tags",
      "name": "Tags",
      "type": "plainText",
      "description": null,
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/System.Tags",
      "isIdentity": false
    },
    {
      "id": "System.BoardColumn",
      "name": "Board Column",
      "type": "string",
      "description": null,
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/System.BoardColumn",
      "isIdentity": false
    },
    {
      "id": "System.BoardColumnDone",
      "name": "Board Column Done",
      "type": "boolean",
      "description": null,
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/System.BoardColumnDone",
      "isIdentity": false
    },
    {
      "id": "System.BoardLane",
      "name": "Board Lane",
      "type": "string",
      "description": null,
      "pickList": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/System.BoardLane",
      "isIdentity": false
    }
  ]
}

Definitions

Name Description
FieldModel
FieldType

FieldModel

Object
Name Type Description
description

string

id

string

isIdentity

boolean

name

string

type

FieldType

url

string

FieldType

Enumeration
Value Description
boolean
dateTime
double
guid
history
html
identity
integer
picklistDouble
picklistInteger
picklistString
plainText
string
treePath