Fields - List

  • Reference
Service:
Work Item Tracking Process
API Version:
6.0-preview.2

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=6.0-preview.2

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 '6.0-preview.2' to use this version of the api.

Responses

Name Type Description
200 OK

ProcessWorkItemTypeField[]

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

Returns a list of all fields in a work item type

Sample Request

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

Sample Response

Status code:
200 
{
  "count": 36,
  "value": [
    {
      "referenceName": "System.State",
      "name": "State",
      "type": "string",
      "required": true,
      "defaultValue": "New",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "inherited"
    },
    {
      "referenceName": "System.Reason",
      "name": "Reason",
      "type": "string",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "inherited"
    },
    {
      "referenceName": "Microsoft.VSTS.Common.ClosedDate",
      "name": "Closed Date",
      "type": "dateTime",
      "description": "",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "inherited"
    },
    {
      "referenceName": "Microsoft.VSTS.Common.ClosedBy",
      "name": "Closed By",
      "type": "string",
      "description": "",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "inherited"
    },
    {
      "referenceName": "Custom.Fields.Colors",
      "name": "Colors",
      "type": "string",
      "description": "My new field",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "custom"
    },
    {
      "referenceName": "System.IterationPath",
      "name": "Iteration Path",
      "type": "treePath",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.ExternalLinkCount",
      "name": "External Link Count",
      "type": "integer",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.TeamProject",
      "name": "Team Project",
      "type": "string",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.HyperLinkCount",
      "name": "Hyperlink Count",
      "type": "integer",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.AttachedFileCount",
      "name": "Attached File Count",
      "type": "integer",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.AreaPath",
      "name": "Area Path",
      "type": "treePath",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.ChangedDate",
      "name": "Changed Date",
      "type": "dateTime",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.Id",
      "name": "ID",
      "type": "integer",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.AuthorizedAs",
      "name": "Authorized As",
      "type": "string",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.Title",
      "name": "Title",
      "type": "string",
      "required": true,
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.AuthorizedDate",
      "name": "Authorized Date",
      "type": "dateTime",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.Rev",
      "name": "Rev",
      "type": "integer",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.ChangedBy",
      "name": "Changed By",
      "type": "string",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.AssignedTo",
      "name": "Assigned To",
      "type": "string",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.WorkItemType",
      "name": "Work Item Type",
      "type": "string",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.CreatedDate",
      "name": "Created Date",
      "type": "dateTime",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.CreatedBy",
      "name": "Created By",
      "type": "string",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.Description",
      "name": "Description",
      "type": "html",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.History",
      "name": "History",
      "type": "history",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.RelatedLinkCount",
      "name": "Related Link Count",
      "type": "integer",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.Tags",
      "name": "Tags",
      "type": "plainText",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.BoardColumn",
      "name": "Board Column",
      "type": "string",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.BoardColumnDone",
      "name": "Board Column Done",
      "type": "boolean",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.BoardLane",
      "name": "Board Lane",
      "type": "string",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.IterationId",
      "name": "Iteration ID",
      "type": "integer",
      "required": true,
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.RemoteLinkCount",
      "name": "Remote Link Count",
      "type": "integer",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.CommentCount",
      "name": "Comment Count",
      "type": "integer",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.NodeName",
      "name": "Node Name",
      "type": "string",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.RevisedDate",
      "name": "Revised Date",
      "type": "dateTime",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.AreaId",
      "name": "Area ID",
      "type": "integer",
      "required": true,
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    },
    {
      "referenceName": "System.Watermark",
      "name": "Watermark",
      "type": "integer",
      "url": "https://dev.azure.com/fabrikamm0652/_apis/work/processes/4bab314e-358e-4bf3-9508-806ba6ac0c30/behaviors",
      "customization": "system"
    }
  ]
}

Definitions

Name Description
CustomizationType

Indicates the type of customization on this work item. System behaviors are inherited from parent process but not modified. Inherited behaviors are modified modified behaviors that were inherited from parent process. Custom behaviors are behaviors created by user in current process.
FieldType
ProcessWorkItemTypeField

Class that describes a field in a work item type and its properties.

CustomizationType

Indicates the type of customization on this work item. System behaviors are inherited from parent process but not modified. Inherited behaviors are modified modified behaviors that were inherited from parent process. Custom behaviors are behaviors created by user in current process.

Name Type Description
custom

string

Customization-type is Custom if the newly created workitemtype is customized.
inherited

string

Customization-type is Inherited if the existing workitemtype of inherited process is customized.
system

string

Customization-type is System if is system generated workitemtype.

FieldType

Name Type Description
boolean

string

Boolean field type.
dateTime

string

DateTime field type.
double

string

Double field type.
guid

string

Guid field type.
history

string

History field type.
html

string

HTML (Multiline) field type.
identity

string

Identity field type.
integer

string

Integer field type.
picklistDouble

string

Double picklist field type.
picklistInteger

string

Integer picklist field type.
picklistString

string

String picklist field type.
plainText

string

Plain text field type.
string

string

String field type.
treePath

string

Treepath field type.

ProcessWorkItemTypeField

Class that describes a field in a work item type and its properties.

Name Type Description
allowGroups

boolean

Allow setting field value to a group identity. Only applies to identity fields.
allowedValues

object[]

The list of field allowed values.
customization

CustomizationType

Indicates the type of customization on this work item.
defaultValue

object

The default value of the field.
description

string

Description of the field.
name

string

Name of the field.
readOnly

boolean

If true the field cannot be edited.
referenceName

string

Reference name of the field.
required

boolean

If true the field cannot be empty.
type

FieldType

Type of the field.
url

string

Resource URL of the field.