通过

Work Item Types - Get

  • 参考
服务:
Work Item Tracking Process
API 版本:
7.1

返回进程中的单个工作项类型。

GET https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workitemtypes/{witRefName}?api-version=7.1
具有可选参数: 
GET https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workitemtypes/{witRefName}?$expand={$expand}&api-version=7.1

URI 参数

名称 在 必需 类型 说明
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。
$expand
 query

GetWorkItemTypeExpand

用于确定要返回的工作项类型的属性的标志

响应

名称 类型 说明
200 OK

ProcessWorkItemType

成功作

安全性

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

示例

Returns a single work item type in a process

示例请求

GET https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workitemtypes/{witRefName}?api-version=7.1

示例响应

状态代码:
200 
{
  "referenceName": "MyNewAgileProcess.ChangeRequest",
  "name": "Change Request",
  "description": "This is my description",
  "url": "https://dev.azure.com/fabricam3/_apis/work/processes/c5ef8a1b-4f0d-48ce-96c4-20e62993c218/workItemTypes/MyNewAgileProcess.ChangeRequest",
  "customization": "custom",
  "color": "f6546a",
  "icon": "icon_airplane",
  "isDisabled": false,
  "inherits": null
}

定义

名称 说明
Control

表示窗体中的控件。
CustomizationType

指示此工作项的自定义类型。 系统行为继承自父进程，但未修改。 继承的行为是从父进程继承的修改行为。 自定义行为是由用户在当前进程中创建的行为。
Extension

表示布局的扩展部分
FormLayout

描述工作项类型的布局
GetWorkItemTypeExpand

用于确定要返回的工作项类型的属性的标志
Group

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

描述工作项窗体布局中的页面
PageType

页面的图标。
ProcessWorkItemType

描述工作项类型对象的类
Section

定义工作项窗体布局的一部分
WitContribution

工作项表单贡献的属性
WorkItemBehaviorReference

对工作项类型的行为的引用。
WorkItemStateResultModel

表示工作项状态结果的类。
WorkItemTypeBehavior

工作项类型与行为之间的关联

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

文本框的水印文本。

CustomizationType

枚举

指示此工作项的自定义类型。 系统行为继承自父进程，但未修改。 继承的行为是从父进程继承的修改行为。 自定义行为是由用户在当前进程中创建的行为。

值 说明
custom

如果新创建的工作项类型已自定义，则自定义类型为 Custom。
inherited

如果自定义了继承进程的现有工作项类型，则自定义自定义类型。
system

自定义类型为 System（如果系统生成的 workitemtype）。

Extension

Object

表示布局的扩展部分

名称 类型 说明
id

string

扩展的 ID

FormLayout

Object

描述工作项类型的布局

名称 类型 说明
extensions

Extension[]

获取和设置扩展列表。
pages

Page[]

布局的顶级选项卡。
systemControls

Control[]

布局的标题控件。

GetWorkItemTypeExpand

枚举

用于确定要返回的工作项类型的属性的标志

值 说明
behaviors

返回获取工作项类型响应中的 behaviors 属性。
layout

返回获取工作项类型响应中的布局属性。
none

返回获取工作项类型响应中的无属性。
states

返回获取工作项类型响应中的状态属性。

Group

Object

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

名称 类型 说明
contribution

WitContribution

组的贡献。
controls

Control[]

要放入组中的控件。
height

integer (int32)

贡献的高度。
id

string

布局节点的 ID。
inherited

boolean

一个值，该值指示此布局节点是否继承自父布局。 这应仅由合并器设置。
isContribution

boolean

一个值，该值指示布局节点是否参与。
label

string

组的标签。
order

integer (int32)

组应在节中显示的顺序。
overridden

boolean

一个值，该值指示此布局节点是否已由子布局重写。
visible

boolean

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

Page

Object

描述工作项窗体布局中的页面

名称 类型 说明
contribution

WitContribution

页面的贡献。
id

string

布局节点的 ID。
inherited

boolean

一个值，该值指示此布局节点是否继承自父布局。 这应仅由合并器设置。
isContribution

boolean

一个值，该值指示布局节点是否参与。
label

string

页面的标签。
locked

boolean

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

integer (int32)

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

boolean

一个值，该值指示此布局节点是否已由子布局重写。
pageType

PageType

页面的图标。
sections

Section[]

页面的各个部分。
visible

boolean

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

PageType

枚举

页面的图标。

值 说明
attachments

附件页类型。
custom

自定义页面类型。
history

历史记录页类型。
links

链接页类型。

ProcessWorkItemType

Object

描述工作项类型对象的类

名称 类型 说明
behaviors

WorkItemTypeBehavior[]

工作项类型与行为之间的关联
color

string

颜色十六进制代码，表示工作项类型
customization

CustomizationType

指示此工作项上的自定义类型系统工作项类型继承自父进程，但未修改继承的工作项类型是从父进程继承的工作项类型自定义工作项类型是当前进程中创建的工作项类型
description

string

工作项类型的说明
icon

string

表示工作项拼写错误的图标
inherits

string

父工作项类型的引用名称
isDisabled

boolean

指示是否禁用工作项类型
layout

FormLayout

描述工作项类型的布局
name

string

工作项类型的名称
referenceName

string

工作项类型的引用名称
states

WorkItemStateResultModel[]

表示工作项状态结果的类。
url

string

工作项类型的 URL

Section

Object

定义工作项窗体布局的一部分

名称 类型 说明
groups

Group[]

本节中的子组列表
id

string

布局节点的 ID。
overridden

boolean

一个值，该值指示此布局节点是否已由子布局重写。

WitContribution

Object

工作项表单贡献的属性

名称 类型 说明
contributionId

string

贡献的 ID。
height

integer (int32)

贡献的高度。
inputs

object

保存供稿输入的键值对的字典。
showOnDeletedWorkItem

boolean

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

WorkItemBehaviorReference

Object

对工作项类型的行为的引用。

名称 类型 说明
id

string

引用行为的 ID。
url

string

引用行为的 URL。

WorkItemStateResultModel

Object

表示工作项状态结果的类。

名称 类型 说明
color

string

工作项状态颜色。
customizationType

CustomizationType

工作项状态自定义类型。
hidden

boolean

如果“工作项”状态处于隐藏状态。
id

string (uuid)

Workitemstate 的 ID。
name

string

工作项状态名称。
order

integer (int32)

工作项状态顺序。
stateCategory

string

工作项状态状态类别。
url

string

工作项状态 URL。

WorkItemTypeBehavior

Object

工作项类型与行为之间的关联

名称 类型 说明
behavior

WorkItemBehaviorReference

对工作项类型的行为的引用
isDefault

boolean

如果为 true，则工作项类型是行为中的默认工作项类型
isLegacyDefault

boolean

如果为 true，则工作项类型为父行为中的默认工作项类型
url

string

工作项类型行为的 URL