Controls - Add

服务:

Work Item Tracking Process Definitions

API 版本:

4.1-preview.1

在组中创建控件

POST https://dev.azure.com/{organization}/_apis/work/processdefinitions/{processId}/workItemTypes/{witRefName}/layout/groups/{groupId}/controls?api-version=4.1-preview.1

URI 参数

名称	在	必需	类型	说明
groupId	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 版本。 这应设置为“4.1-preview.1”才能使用此版本的 API。

请求正文

名称	类型	说明
contribution	WitContribution	控件的贡献。
controlType	string	控件的类型。
height	integer	控件的高度，对于 html 控件。
id	string	布局节点的 ID。
inherited	boolean	一个 值，该值指示此布局节点是否已从父布局继承。 这只能由合并器设置。
isContribution	boolean	一个 值，该值指示布局节点是否为贡献节点。
label	string	字段标签
metadata	string	控件的内部文本。
order	integer
overridden	boolean	一个 值，该值指示此布局节点是否已被子布局覆盖。
readOnly	boolean	一个值，该值指示控件是否为只读控件。
visible	boolean	一个 值，该值指示控件是否应隐藏。
watermark	string	文本框的水印文本。

响应

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

安全性

accessToken

个人访问令牌。 将任何值用作用户名和令牌作为密码。

类型: basic

示例

Create a control in a group

示例请求

HTTP

POST https://dev.azure.com/{organization}/_apis/work/processdefinitions/{processId}/workItemTypes/{witRefName}/layout/groups/{groupId}/controls?api-version=4.1-preview.1

{
  "order": null,
  "label": "",
  "readOnly": false,
  "visible": true,
  "controlType": null,
  "metadata": null,
  "inherited": null,
  "overridden": null,
  "watermark": null,
  "contribution": {
    "contributionId": "ms-devlabs.toggle-control.toggle-control-contribution",
    "inputs": {
      "FieldName": "System.BoardColumnDone"
    },
    "height": null,
    "showOnDeletedWorkItem": null
  },
  "isContribution": true,
  "height": null
}

示例响应

状态代码:

200

{
  "id": "c1681eea-cf9e-4a32-aee9-83e97fde894a",
  "label": "",
  "readOnly": false,
  "visible": true,
  "contribution": {
    "contributionId": "ms-devlabs.toggle-control.toggle-control-contribution",
    "inputs": {
      "FieldName": "System.BoardColumnDone"
    }
  },
  "isContribution": true
}

定义

名称	说明
Control	表示窗体中的控件。
WitContribution

Control

Object

表示窗体中的控件。

名称	类型	说明
contribution	WitContribution	控件的贡献。
controlType	string	控件的类型。
height	integer	控件的高度，对于 html 控件。
id	string	布局节点的 ID。
inherited	boolean	一个 值，该值指示此布局节点是否已从父布局继承。 这只能由合并器设置。
isContribution	boolean	一个 值，该值指示布局节点是否为贡献节点。
label	string	字段标签
metadata	string	控件的内部文本。
order	integer
overridden	boolean	一个 值，该值指示此布局节点是否已被子布局覆盖。
readOnly	boolean	一个值，该值指示控件是否为只读控件。
visible	boolean	一个 值，该值指示控件是否应隐藏。
watermark	string	文本框的水印文本。

WitContribution

Object

名称	类型	说明
contributionId	string	贡献的 ID。
height	integer	贡献的高度。
inputs	object	包含贡献输入的键值对的字典。
showOnDeletedWorkItem	boolean	一个值，该值指示是否应在已删除的 workItem 上显示贡献。