Fields - Update

服务:

Work Item Tracking Process Definitions

API 版本:

4.1-preview.1

汇报进程中的给定字段。

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

URI 参数

名称	在	必需	类型	说明
organization	path	True	string	Azure DevOps 组织的名称。
processId	path	True	string uuid	进程的 ID
api-version	query	True	string	要使用的 API 版本。 这应设置为“4.1-preview.1”才能使用此版本的 API。

请求正文

名称	类型	说明
description	string
id	string

响应

名称	类型	说明
200 OK	FieldModel	成功的操作

安全性

accessToken

个人访问令牌。 将任何值用作用户名和令牌作为密码。

类型: basic

示例

Update the field

示例请求

HTTP

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

{
  "id": "myAgile.NewField",
  "description": "New description"
}

示例响应

状态代码:

200

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

定义

名称	说明
FieldModel
FieldType	字段类型
FieldUpdate
PickListMetadataModel

FieldModel

Object

名称	类型	说明
description	string	有关字段的说明
id	string	字段的 ID
name	string	字段的名称
pickList	PickListMetadataModel	此字段中对选择列表的引用
type	FieldType	字段类型
url	string	字段的 URL

FieldType

Enumeration

字段类型

值	说明
boolean
dateTime
double
guid
history
html
identity
integer
picklistDouble
picklistInteger
picklistString
plainText
string
treePath

FieldUpdate

Object

名称	类型	说明
description	string
id	string

PickListMetadataModel

Object

名称	类型	说明
id	string	选择列表的 ID
isSuggested	boolean	用户的输入值是否仅限于建议的值
name	string	选择列表的名称
type	string	选择列表的类型
url	string	选择列表的 URL