Fields - Get

Service:

Work Item Tracking Process

API Version:

5.0-preview.2

返回工作项类型中的字段。

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

URI 参数

名称	在	必需	类型	说明
fieldRefName	path	True	string	字段的引用名称。
organization	path	True	string	Azure DevOps 组织的名称。
processId	path	True	string uuid	进程的 ID。
witRefName	path	True	string	工作项类型的引用名称。
api-version	query	True	string	要使用的 API 版本。 应将其设置为“5.0-preview.2”才能使用此版本的 API。

响应

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

安全性

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

名称	说明
vso.work	授予读取工作项、查询、板、区域和迭代路径以及其他工作项跟踪相关元数据的能力。 此外，还允许通过服务挂钩执行查询、搜索工作项和接收有关工作项事件的通知。

定义

名称	说明
CustomizationType	指示此工作项的自定义类型。 系统行为继承自父进程，但未修改。 继承的行为是从父进程继承的修改后的行为。 自定义行为是用户在当前进程中创建的行为。
FieldType
ProcessWorkItemTypeField	描述工作项类型中的字段及其属性的类。

CustomizationType

指示此工作项的自定义类型。 系统行为继承自父进程，但未修改。 继承的行为是从父进程继承的修改后的行为。 自定义行为是用户在当前进程中创建的行为。

名称	类型	说明
custom	string	如果自定义了新创建的 workitemtype，则 Custom-type 为 Custom。
inherited	string	如果自定义继承进程的现有 workitemtype，则自定义自定义类型。
system	string	如果 是系统生成的 workitemtype，则 Customization-type 为 System。

FieldType

名称	类型	说明
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

ProcessWorkItemTypeField

描述工作项类型中的字段及其属性的类。

名称	类型	说明
allowGroups	boolean	允许将字段值设置为组标识。 仅适用于标识字段。
customization	CustomizationType
defaultValue	object	字段的默认值。
description	string	字段的说明。
name	string	字段的名称。
readOnly	boolean	如果为 true，则无法编辑字段。
referenceName	string	字段的引用名称。
required	boolean	如果为 true，则字段不能为空。
type	FieldType	字段的类型。
url	string	字段的资源 URL。