通过

Work Item Types - Create

  • 参考
服务:
Work Item Tracking Process Definitions
API 版本:
4.1-preview.1

在进程中创建工作项类型。

POST https://dev.azure.com/{organization}/_apis/work/processdefinitions/{processId}/workitemtypes?api-version=4.1-preview.1

URI 参数

名称 在 必需 类型 说明
organization
 path True

string

Azure DevOps 组织的名称。
processId
 path True

string

uuid

进程的 ID
api-version
 query True

string

要使用的 API 版本。 这应设置为“4.1-preview.1”才能使用此版本的 API。

请求正文

名称 类型 说明
behaviors

WorkItemTypeBehavior[]

工作项类型的行为
class

WorkItemTypeClass

工作项类型的类
color

string

工作项类型的颜色
description

string

工作项类型的说明
icon

string

工作项类型的图标
id

string

工作项类型的 ID
inherits

string

继承自的父 WIT ID/内部引用名称
isDisabled

boolean

是否禁用了工作项类型
layout

FormLayout

工作项类型的布局
name

string

工作项类型的名称
states

WorkItemStateResultModel[]

工作项类型的状态
url

string

工作项类型的 URL

响应

名称 类型 说明
200 OK

WorkItemTypeModel

成功的操作

安全性

accessToken

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

类型: basic

示例

Create work item type

示例请求

POST https://dev.azure.com/{organization}/_apis/work/processdefinitions/{processId}/workitemtypes?api-version=4.1-preview.1

{
  "name": "NewWIT",
  "states": [],
  "behaviors": [],
  "color": "009CCC",
  "icon": "icon_clipboard",
  "description": null,
  "id": null,
  "inherits": null,
  "isDisabled": false,
  "layout": null,
  "url": null,
  "class": null
}

示例响应

状态代码:
200 
{
  "id": "myAgile.NewWIT",
  "name": "NewWIT",
  "description": null,
  "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/myAgile.NewWIT",
  "inherits": null,
  "class": "custom",
  "color": "009CCC",
  "icon": "icon_clipboard",
  "isDisabled": false
}

定义

名称 说明
Control

表示窗体中的控件。
Extension

表示布局的扩展部分
FormLayout
Group

表示窗体中保存控件的组。
Page
PageType

页面的图标。
Section

在页面中一起存放组的布局节点
WitContribution
WorkItemBehaviorReference
WorkItemStateResultModel
WorkItemTypeBehavior
WorkItemTypeClass

工作项类型的类
WorkItemTypeModel

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

文本框的水印文本。

Extension

Object

表示布局的扩展部分

名称 类型 说明
id

string

FormLayout

Object
名称 类型 说明
extensions

Extension[]

获取和设置扩展列表
pages

Page[]

布局的顶级选项卡。
systemControls

Control[]

布局的标题控件。

Group

Object

表示窗体中保存控件的组。

名称 类型 说明
contribution

WitContribution

组的贡献。
controls

Control[]

要放入组中的控件。
height

integer

贡献的高度。
id

string

布局节点的 ID。
inherited

boolean

一个 值，该值指示此布局节点是否已从父布局继承。 这只能由合并器设置。
isContribution

boolean

一个值，该值指示布局节点是否为贡献。
label

string

组的标签。
order

integer

组在 节中的显示顺序。
overridden

boolean

一个 值，该值指示此布局节点是否已被子布局覆盖。
visible

boolean

一个 值，该值指示是否应隐藏组。

Page

Object
名称 类型 说明
contribution

WitContribution

页面的贡献。
id

string

布局节点的 ID。
inherited

boolean

一个 值，该值指示此布局节点是否已从父布局继承。 这只能由合并器设置。
isContribution

boolean

一个值，该值指示布局节点是否为贡献。
label

string

页面的标签。
locked

boolean

一个值，该值指示是否允许在此页面上进行任何用户操作以及此页面的内容
order

integer

页面在布局中的显示顺序。
overridden

boolean

一个 值，该值指示此布局节点是否已被子布局覆盖。
pageType

PageType

页面的图标。
sections

Section[]

页面的各个部分。
visible

boolean

一个值，该值指示是否应隐藏页面。

PageType

Enumeration

页面的图标。

值 说明
attachments
custom
history
links

Section

Object

在页面中一起存放组的布局节点

名称 类型 说明
groups

Group[]

表示窗体中保存控件的组。
id

string

布局节点的 ID。
overridden

boolean

一个 值，该值指示此布局节点是否已被子布局覆盖。

WitContribution

Object
名称 类型 说明
contributionId

string

贡献的 ID。
height

integer

贡献的高度。
inputs

object

包含贡献输入的键值对的字典。
showOnDeletedWorkItem

boolean

一个值，该值指示是否应在已删除的 workItem 上显示贡献。

WorkItemBehaviorReference

Object
名称 类型 说明
id

string

引用行为的 ID
url

string

引用行为的 URL

WorkItemStateResultModel

Object
名称 类型 说明
color

string

状态的颜色
hidden

boolean

状态是否隐藏
id

string

状态的 ID
name

string

状态的名称
order

integer

显示状态的顺序
stateCategory

string

状态的类别
url

string

状态的 URL

WorkItemTypeBehavior

Object
名称 类型 说明
behavior

WorkItemBehaviorReference

isDefault

boolean

url

string

WorkItemTypeClass

Enumeration

工作项类型的类

值 说明
custom
derived
system

WorkItemTypeModel

Object
名称 类型 说明
behaviors

WorkItemTypeBehavior[]

工作项类型的行为
class

WorkItemTypeClass

工作项类型的类
color

string

工作项类型的颜色
description

string

工作项类型的说明
icon

string

工作项类型的图标
id

string

工作项类型的 ID
inherits

string

继承自的父 WIT ID/内部引用名称
isDisabled

boolean

是否禁用了工作项类型
layout

FormLayout

工作项类型的布局
name

string

工作项类型的名称
states

WorkItemStateResultModel[]

工作项类型的状态
url

string

工作项类型的 URL