System Controls - Update

参考

服务:: Work Item Tracking Process

API 版本:: 7.1

更新/添加工作项窗体上的系统控件。

PATCH https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/layout/systemcontrols/{controlId}?api-version=7.1

URI 参数

名称	在	必需	类型	说明
controlId	path	True	string	控件的 ID。
organization	path	True	string	Azure DevOps 组织的名称。
processId	path	True	string (uuid)	进程的 ID。
witRefName	path	True	string	工作项类型的引用名称。
api-version	query	True	string	要使用的 API 版本。这应设置为“7.1”才能使用此版本的 API。

请求正文

名称	类型	说明
contribution	WitContribution	控件的贡献。
controlType	string	控件的类型。
height	integer (int32)	控件的高度，对于 html 控件。
id	string	布局节点的 ID。
inherited	boolean	一个值，该值指示是否已继承此布局节点。从父布局。这应仅由合并器设置。
isContribution	boolean	一个值，该值指示布局节点是否参与。
label	string	字段的标签。
metadata	string	控件的内部文本。
order	integer (int32)	控件应在其组中显示的顺序。
overridden	boolean	一个值，该值指示是否已重写此布局节点。按子布局。
readOnly	boolean	一个值，指示控件是否是只读的。
visible	boolean	一个值，指示控件是否应隐藏。
watermark	string	文本框的水印文本。

响应

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

安全性

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

示例

Update/Add a System Control

示例请求

HTTP

PATCH https://dev.azure.com/{organization}/_apis/work/processes/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/{witRefName}/layout/systemcontrols/System.Reason?api-version=7.1

{
  "visible": false
}

示例响应

状态代码:: 200

{
  "id": "System.Reason",
  "label": "Reason",
  "controlType": "FieldControl",
  "readOnly": false,
  "visible": false,
  "isContribution": false
}

定义

名称	说明
Control	表示窗体中的控件。
WitContribution	工作项表单贡献的属性

Control

Object

表示窗体中的控件。

名称	类型	说明
contribution	WitContribution	控件的贡献。
controlType	string	控件的类型。
height	integer (int32)	控件的高度，对于 html 控件。
id	string	布局节点的 ID。
inherited	boolean	一个值，该值指示是否已继承此布局节点。从父布局。这应仅由合并器设置。
isContribution	boolean	一个值，该值指示布局节点是否参与。
label	string	字段的标签。
metadata	string	控件的内部文本。
order	integer (int32)	控件应在其组中显示的顺序。
overridden	boolean	一个值，该值指示是否已重写此布局节点。按子布局。
readOnly	boolean	一个值，指示控件是否是只读的。
visible	boolean	一个值，指示控件是否应隐藏。
watermark	string	文本框的水印文本。

WitContribution