Work Item Types Fields - Get

Service:

Work Item Tracking Process Definitions

API Version:

4.1-preview.1

Returns a single field in the work item type of the process.

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

URI Parameters

Name	In	Required	Type	Description
fieldRefName	path	True	string	The reference name of the field
organization	path	True	string	The name of the Azure DevOps organization.
processId	path	True	string (uuid)	The ID of the process
witRefNameForFields	path	True	string	Work item type reference name for fields
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	WorkItemTypeFieldModel	successful operation

Security

accessToken

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

Type: basic

Examples

Get field from work item type

Sample request

HTTP

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

Sample response

Status code:

200

{
  "count": 3,
  "value": [
    {
      "referenceName": "myAgile.newfield1",
      "name": "newfield1",
      "type": "string",
      "pickList": {
        "id": "a07a079a-c79e-4221-9436-a9d732a8a4d0",
        "name": "picklist_aef2c045-0d2d-4f92-9d09-56eea553e1ef",
        "type": "String",
        "isSuggested": false,
        "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/lists/a07a079a-c79e-4221-9436-a9d732a8a4d0"
      },
      "readOnly": false,
      "required": false,
      "defaultValue": null,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/myAgile.CustomWIT/fields/myAgile.newfield1",
      "allowGroups": null
    }
  ]
}

Definitions

Name	Description
FieldType	Type of field
PickListMetadataModel
WorkItemTypeFieldModel

FieldType

Enumeration

Type of field

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

PickListMetadataModel

Object

Name	Type	Description
id	string (uuid)	ID of the picklist
isSuggested	boolean	Is input values by user only limited to suggested values
name	string	Name of the picklist
type	string	Type of picklist
url	string	Url of the picklist

WorkItemTypeFieldModel

Object

Name	Type	Description
allowGroups	boolean
defaultValue	string
name	string
pickList	PickListMetadataModel
readOnly	boolean
referenceName	string
required	boolean
type	FieldType
url	string