States - List

参考

服务:: Work Item Tracking Process

API 版本:: 7.1

返回进程的工作项类型中所有状态定义的列表。

GET https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/states?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。

响应

名称	类型	说明
200 OK	WorkItemStateResultModel[]	成功作

安全性

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

示例

Get state definitions

示例请求

HTTP

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

示例响应

状态代码:: 200

{
  "count": 4,
  "value": [
    {
      "id": "7b7e3e8c-e500-40b6-ad56-d59b8d64d757",
      "name": "New",
      "color": "b2b2b2",
      "stateCategory": "Proposed",
      "order": 1,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/states/7b7e3e8c-e500-40b6-ad56-d59b8d64d757"
    },
    {
      "id": "277237cd-0bc0-4ffb-bdc6-d358b154ba9e",
      "name": "Active",
      "color": "007acc",
      "stateCategory": "InProgress",
      "order": 2,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/states/277237cd-0bc0-4ffb-bdc6-d358b154ba9e"
    },
    {
      "id": "f36cfea7-889a-448e-b5d1-fbc9b134ec82",
      "name": "Resolved",
      "color": "ff9d00",
      "stateCategory": "Resolved",
      "order": 3,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/states/f36cfea7-889a-448e-b5d1-fbc9b134ec82"
    },
    {
      "id": "9f479b88-4542-4f9d-8048-5d9c953b5082",
      "name": "Closed",
      "color": "339933",
      "stateCategory": "Completed",
      "order": 4,
      "url": "https://dev.azure.com/fabrikam/_apis/work/processDefinitions/a6c1d9b6-ea27-407d-8c40-c9b7ab112bb6/workItemTypes/Microsoft.VSTS.WorkItemTypes.Bug/states/9f479b88-4542-4f9d-8048-5d9c953b5082"
    }
  ]
}

定义

名称	说明
CustomizationType	指示此工作项的自定义类型。系统行为继承自父进程，但未修改。继承的行为是从父进程继承的修改行为。自定义行为是由用户在当前进程中创建的行为。
WorkItemStateResultModel	表示工作项状态结果的类。

CustomizationType

枚举

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

值	说明
custom	如果新创建的工作项类型已自定义，则自定义类型为 Custom。
inherited	如果自定义了继承进程的现有工作项类型，则自定义自定义类型。
system	自定义类型为 System（如果系统生成的 workitemtype）。

WorkItemStateResultModel

Object

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

名称	类型	说明
color	string	工作项状态颜色。
customizationType	CustomizationType	工作项状态自定义类型。
hidden	boolean	如果“工作项”状态处于隐藏状态。
id	string (uuid)	Workitemstate 的 ID。
name	string	工作项状态名称。
order	integer (int32)	工作项状态顺序。
stateCategory	string	工作项状态状态类别。
url	string	工作项状态 URL。

通过