Fields - Update

参考

Service:: Work Item Tracking

API Version:: 7.1-preview.3

更新字段。

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

URI 参数

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

请求正文

名称	类型	说明
isDeleted	boolean	指示用户是否要还原字段。
isLocked	boolean	指示用户是否要锁定字段。

响应

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

安全性

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_write	授予读取、创建和更新工作项和查询、更新板元数据、读取区域和迭代路径等工作项跟踪相关元数据、执行查询以及通过服务挂钩接收有关工作项事件的通知的能力。

示例

Set field locked

Undelete a field

Set field locked

Sample Request

HTTP

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

{
  "isLocked": true
}

Sample Response

Status code:: 200

persistent-Auth: true
lfs-Authenticate: NTLM
wwW-Authenticate: Negotiate oRswGaADCgEAoxIEEAEAAAAMDzOy0XQtlQAAAAA=

Response Body

{
  "name": "New Work Item Field3",
  "referenceName": "Custom.TestField",
  "description": "New work item field for testing",
  "type": "string",
  "usage": "workItem",
  "readOnly": false,
  "canSortBy": true,
  "isQueryable": true,
  "supportedOperations": [
    {
      "referenceName": "SupportedOperations.Equals",
      "name": "="
    },
    {
      "referenceName": "SupportedOperations.NotEquals",
      "name": "<>"
    },
    {
      "referenceName": "SupportedOperations.GreaterThan",
      "name": ">"
    },
    {
      "referenceName": "SupportedOperations.LessThan",
      "name": "<"
    },
    {
      "referenceName": "SupportedOperations.GreaterThanEquals",
      "name": ">="
    },
    {
      "referenceName": "SupportedOperations.LessThanEquals",
      "name": "<="
    },
    {
      "referenceName": "SupportedOperations.Contains",
      "name": "Contains"
    },
    {
      "referenceName": "SupportedOperations.NotContains",
      "name": "Does Not Contain"
    },
    {
      "referenceName": "SupportedOperations.In",
      "name": "In"
    },
    {
      "name": "Not In"
    },
    {
      "referenceName": "SupportedOperations.InGroup",
      "name": "In Group"
    },
    {
      "referenceName": "SupportedOperations.NotInGroup",
      "name": "Not In Group"
    },
    {
      "referenceName": "SupportedOperations.Ever",
      "name": "Was Ever"
    },
    {
      "referenceName": "SupportedOperations.EqualsField",
      "name": "= [Field]"
    },
    {
      "referenceName": "SupportedOperations.NotEqualsField",
      "name": "<> [Field]"
    },
    {
      "referenceName": "SupportedOperations.GreaterThanField",
      "name": "> [Field]"
    },
    {
      "referenceName": "SupportedOperations.LessThanField",
      "name": "< [Field]"
    },
    {
      "referenceName": "SupportedOperations.GreaterThanEqualsField",
      "name": ">= [Field]"
    },
    {
      "referenceName": "SupportedOperations.LessThanEqualsField",
      "name": "<= [Field]"
    }
  ],
  "isIdentity": false,
  "isPicklist": false,
  "isLocked": true,
  "isPicklistSuggested": false,
  "url": "http://localhost/DefaultCollection/_apis/wit/fields/Custom.TestField"
}

Undelete a field

Sample Request

HTTP

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

{
  "isDeleted": false
}

Sample Response

Status code:: 200

persistent-Auth: true
lfs-Authenticate: NTLM
wwW-Authenticate: Negotiate oRswGaADCgEAoxIEEAEAAAAMDzOy0XQtlQAAAAA=

Response Body

{
  "name": "New Work Item Field3",
  "referenceName": "Custom.TestField",
  "description": "New work item field for testing",
  "type": "string",
  "usage": "workItem",
  "readOnly": false,
  "canSortBy": true,
  "isQueryable": true,
  "supportedOperations": [
    {
      "referenceName": "SupportedOperations.Equals",
      "name": "="
    },
    {
      "referenceName": "SupportedOperations.NotEquals",
      "name": "<>"
    },
    {
      "referenceName": "SupportedOperations.GreaterThan",
      "name": ">"
    },
    {
      "referenceName": "SupportedOperations.LessThan",
      "name": "<"
    },
    {
      "referenceName": "SupportedOperations.GreaterThanEquals",
      "name": ">="
    },
    {
      "referenceName": "SupportedOperations.LessThanEquals",
      "name": "<="
    },
    {
      "referenceName": "SupportedOperations.Contains",
      "name": "Contains"
    },
    {
      "referenceName": "SupportedOperations.NotContains",
      "name": "Does Not Contain"
    },
    {
      "referenceName": "SupportedOperations.In",
      "name": "In"
    },
    {
      "name": "Not In"
    },
    {
      "referenceName": "SupportedOperations.InGroup",
      "name": "In Group"
    },
    {
      "referenceName": "SupportedOperations.NotInGroup",
      "name": "Not In Group"
    },
    {
      "referenceName": "SupportedOperations.Ever",
      "name": "Was Ever"
    },
    {
      "referenceName": "SupportedOperations.EqualsField",
      "name": "= [Field]"
    },
    {
      "referenceName": "SupportedOperations.NotEqualsField",
      "name": "<> [Field]"
    },
    {
      "referenceName": "SupportedOperations.GreaterThanField",
      "name": "> [Field]"
    },
    {
      "referenceName": "SupportedOperations.LessThanField",
      "name": "< [Field]"
    },
    {
      "referenceName": "SupportedOperations.GreaterThanEqualsField",
      "name": ">= [Field]"
    },
    {
      "referenceName": "SupportedOperations.LessThanEqualsField",
      "name": "<= [Field]"
    }
  ],
  "isIdentity": false,
  "isPicklist": false,
  "isPicklistSuggested": false,
  "url": "http://localhost/DefaultCollection/_apis/wit/fields/Custom.TestField"
}

定义

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

FieldType

字段的类型。

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

FieldUpdate

描述工作项字段的更新请求。

名称	类型	说明
isDeleted	boolean	指示用户是否要还原字段。
isLocked	boolean	指示用户是否要锁定字段。

FieldUsage

字段的用法。

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

ReferenceLinks

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

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

WorkItemField2

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

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

WorkItemFieldOperation

描述工作项字段操作。

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

通过

Fields - Update

URI 参数

请求正文

响应

安全性

oauth2

Scopes

示例

Set field locked

Sample Request

Sample Response

Undelete a field

Sample Request

Sample Response

定义

FieldType

FieldUpdate

FieldUsage

ReferenceLinks

WorkItemField2

WorkItemFieldOperation

其他资源