Fields - Get

服务:

Work Item Tracking

API 版本:

7.1

获取有关特定字段的信息。

GET https://dev.azure.com/{organization}/{project}/_apis/wit/fields/{fieldNameOrRefName}?api-version=7.1

URI 参数

名称	在	必需	类型	说明
fieldNameOrRefName	path	True	string	字段简单名称或引用名称
organization	path	True	string	Azure DevOps 组织的名称。
project	path		string	项目 ID 或项目名称
api-version	query	True	string	要使用的 API 版本。 这应设置为“7.1”才能使用此版本的 API。

响应

名称	类型	说明
200 OK	WorkItemField2	成功作

安全性

oauth2

类型: oauth2
流向: accessCode
授权 URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
令牌 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

作用域

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

示例

Gets information on a specific field

示例请求

HTTP

GET https://dev.azure.com/fabrikam/_apis/wit/fields/{fieldNameOrRefName}?api-version=7.1

示例响应

状态代码:

200

{
  "name": "Iteration Path",
  "referenceName": "System.IterationPath",
  "type": "treePath",
  "readOnly": true,
  "supportedOperations": [
    {
      "referenceName": "SupportedOperations.Under",
      "name": "Under"
    },
    {
      "referenceName": "SupportedOperations.NotUnder",
      "name": "Not Under"
    },
    {
      "referenceName": "SupportedOperations.Equals",
      "name": "="
    },
    {
      "referenceName": "SupportedOperations.NotEquals",
      "name": "<>"
    },
    {
      "referenceName": "SupportedOperations.In",
      "name": "In"
    }
  ],
  "url": "https://dev.azure.com/fabrikam/_apis/wit/fields/System.IterationPath"
}

定义

名称	说明
FieldType	字段的类型。
FieldUsage	字段的用法。
ReferenceLinks	表示 REST 引用链接集合的类。
WorkItemField2	描述工作项上的字段，它是特定于该工作项类型的属性。
WorkItemFieldOperation	描述工作项字段作。

FieldType

枚举

字段的类型。

值	说明
boolean	布尔字段类型。
dateTime	日期/时间字段类型。
double	双字段类型。
guid	Guid 字段类型。
history	历史记录字段类型。
html	HTML（多行）字段类型。
identity	标识字段类型。
integer	整数字段类型。
picklistDouble	双选列表字段类型。 从 REST API 创建双选列表字段时，请使用“Double”FieldType。
picklistInteger	整数选取列表字段类型。 从 REST API 创建整数选取列表字段时，请使用“Integer”FieldType。
picklistString	字符串选取列表字段类型。 从 REST API 创建字符串选取列表字段时，请使用“String”FieldType。
plainText	纯文本字段类型。
string	字符串字段类型。
treePath	树路径字段类型。

FieldUsage

枚举

字段的用法。

值	说明
none	空使用情况。
tree	树节点字段用法。
workItem	工作项字段使用情况。
workItemLink	工作项链接字段使用情况。
workItemTypeExtension	工作项类型扩展用法。

ReferenceLinks

Object

表示 REST 引用链接集合的类。

名称	类型	说明
links	object	链接的只读视图。 由于引用链接是只读的，因此我们只想将其公开为只读链接。

WorkItemField2

Object

描述工作项上的字段，它是特定于该工作项类型的属性。

名称	类型	说明
_links	ReferenceLinks	链接对相关 REST 资源的引用。
canSortBy	boolean	指示字段是否在服务器查询中可排序。
description	string	字段的说明。
isDeleted	boolean	指示是否删除此字段。
isIdentity	boolean	指示此字段是否为标识字段。
isLocked	boolean	指示此字段是否标记为已锁定进行编辑。
isPicklist	boolean	指示此实例是否为 picklist。
isPicklistSuggested	boolean	指示此实例是否为建议的选取列表。
isQueryable	boolean	指示是否可以在服务器中查询字段。
name	string	字段的名称。
picklistId	string (uuid)	如果此字段为 picklist，则为关联的选取列表的标识符，否则为 null
readOnly	boolean	指示字段是否为 [只读]。
referenceName	string	字段的引用名称。
supportedOperations	WorkItemFieldOperation[]	此字段上支持的作。
type	FieldType	字段的类型。
url	string
usage	FieldUsage	字段的用法。

WorkItemFieldOperation

Object

描述工作项字段作。

名称	类型	说明
name	string	作的友好名称。
referenceName	string	作的引用名称。