Fields - Get

参考

Service:: Work Item Tracking

API Version:: 4.1

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

GET https://{instance}/{collection}/{project}/_apis/wit/fields/{fieldNameOrRefName}?api-version=4.1

URI 参数

名称	在	必需	类型	说明
collection	path	True	string	Team Foundation Server 集合的名称。
fieldNameOrRefName	path	True	string	字段简单名称或引用名称
instance	path	True	string	TFS 服务器名称 ({server：port})
project	path		string	项目 ID 或项目名称
api-version	query	True	string	要使用的 API 版本。应将其设置为“4.1”才能使用此版本的 API。

响应

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

安全性

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	授予读取工作项、查询、板、区域和迭代路径以及其他工作项跟踪相关元数据的能力。此外，还允许通过服务挂钩执行查询和接收有关工作项事件的通知。

示例

Sample Request

HTTP

GET https://{instance}/{collection}/_apis/wit/fields/{fieldNameOrRefName}?api-version=4.1

Sample Response

Status code:: 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://fabrikam:8080/tfs/_apis/wit/fields/System.IterationPath"
}

定义

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

FieldType

字段的类型。

名称	类型	说明
boolean	string	布尔字段类型。
dateTime	string	日期/时间字段类型。
double	string	双精度字段类型。
guid	string	Guid 字段类型。
history	string	历史记录字段类型。
html	string	HTML (多行) 字段类型。
identity	string	标识字段类型。
integer	string	整数字段类型。
picklistDouble	string	双选取列表字段类型。
picklistInteger	string	整数选取列表字段类型。
picklistString	string	字符串选取列表字段类型。
plainText	string	纯文本字段类型。
string	string	字符串字段类型。
treePath	string	树路径字段类型。

FieldUsage

字段的用法。

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

ReferenceLinks

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

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

WorkItemField

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

名称	类型	说明
_links	ReferenceLinks	将引用链接到相关的 REST 资源。
description	string	字段的说明。
isIdentity	boolean	指示此字段是否为标识字段。
isPicklist	boolean	指示此实例是否为选择列表。
isPicklistSuggested	boolean	指示此实例是否为建议的选择列表。
name	string	字段的名称。
readOnly	boolean	指示字段是否为 [只读]。
referenceName	string	字段的引用名称。
supportedOperations	WorkItemFieldOperation[]	此字段支持的操作。
type	FieldType	字段的类型。
url	string
usage	FieldUsage	字段的用法。

WorkItemFieldOperation

描述工作项字段操作。

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

通过