Fields - Create

Creates a single field in the process.

POST https://dev.azure.com/{organization}/_apis/work/processdefinitions/{processId}/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

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.

Request Body

Name Type Description
description
  • string

Description about field

id
  • string

ID of the field

name
  • string

Name of the field

pickList

Reference to picklist in this field

type

Type of field

url
  • string

Url to the field

Responses

Name Type Description
200 OK

successful operation

Security

accessToken

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

Type: basic

Examples

Create new field

Sample Request

POST https://dev.azure.com/{organization}/_apis/work/processdefinitions/{processId}/fields?api-version=4.1-preview.1
{
  "id": null,
  "url": null,
  "description": "",
  "name": "NewField",
  "type": 1,
  "pickList": null
}

Sample Response

{
  "id": "myAgile.NewField",
  "name": "NewField",
  "type": "string",
  "description": "",
  "pickList": null,
  "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/fields/myAgile.NewField",
  "isIdentity": false
}

Definitions

FieldModel
FieldType

Type of field

PickListMetadataModel

FieldModel

Name Type Description
description
  • string

Description about field

id
  • string

ID of the field

name
  • string

Name of the field

pickList

Reference to picklist in this field

type

Type of field

url
  • string

Url to the field

FieldType

Type of field

Name Type Description
boolean
  • string
dateTime
  • string
double
  • string
guid
  • string
history
  • string
html
  • string
identity
  • string
integer
  • string
picklistDouble
  • string
picklistInteger
  • string
picklistString
  • string
plainText
  • string
string
  • string
treePath
  • string

PickListMetadataModel

Name Type Description
id
  • string

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