查询工作项流程信息
功能介绍
查询工作项流程信息
调用方法
请参见如何调用API。
URI
GET /v1/ipdprojectservice/projects/{project_id}/work-item/{issue_id}/flow/detail
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目的32位uuid,项目唯一标识,通过查询项目列表(WorkSpace服务)接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
issue_id |
是 |
String |
参数解释: 工作项唯一Id。可以通过查询工作项列表或者查询树状工作接口获取,响应消息体中的id字段的值就是工作项ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
issue_category |
是 |
String |
参数解释: 工作项类型。 约束限制: 不涉及。 取值范围: 系统设备类项目可选值为:RR/SF/IR/SR/AR/Task/Bug,独立软件类项目可选值为:RR/SF/IR/US/Task/Bug,云服务类项目可选值为:RR/Epic/FE/US/Task/Bug。支持多种工作项类型,使用英文逗号分隔,如category=IR,SR,AR。 默认取值: 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 最小长度:10,最大长度:32768。 默认取值: 不涉及。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
status |
String |
参数解释: 状态码。 取值范围: 不涉及。 |
|
message |
String |
参数解释: 响应信息。 取值范围: 不涉及。 |
|
result |
WorkItemFlowInfoVO object |
参数解释: 工作流详情信息响应体。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
process_instance |
参数解释: 工作项工作流示例信息。 取值范围: 不涉及。 |
|
|
next_flow |
Array of FlowsInfoVO objects |
参数解释: 可以流转的流转线信息。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
process_instance |
参数解释: 工作项工作流示例信息。 取值范围: 不涉及。 |
|
|
next_flow |
Array of FlowsInfoVO objects |
参数解释: 可以流转的流转线信息。 取值范围: 不涉及。 |
|
code |
String |
参数解释: 流转线code。 取值范围: 不涉及。 |
|
name |
String |
参数解释: 流转线名称。 取值范围: 不涉及。 |
|
description |
String |
参数解释: 流转线描述信息。 取值范围: 不涉及。 |
|
from_code |
String |
参数解释: 当前工作流节点code。 取值范围: 不涉及。 |
|
to_code |
String |
参数解释: 目标工作流节点code。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
process_instance |
参数解释: 工作项工作流示例信息。 取值范围: 不涉及。 |
|
|
next_flow |
Array of FlowsInfoVO objects |
参数解释: 可以流转的流转线信息。 取值范围: 不涉及。 |
|
id |
String |
参数解释: 工作项工作流实例id。 取值范围: 不涉及。 |
|
flow_state |
Integer |
参数解释: 工作流示例是否挂起。 取值范围: 1: 运行 2: 挂起 |
请求示例
查询工作项IR,id为1169236596358213632的工作项的工作流信息
GET /v1/ipdprojectservice/projects/9df557a4017d4b1b9cd53b96e44a4a50/work-item/1169236596358213632/flow/detail?issue_category=IR
响应示例
状态码:200
查询工作项流程信息接口成功的响应。
{
"status" : "success",
"message" : null,
"result" : {
"process_instance" : {
"id" : "1169236596680073217",
"flow_state" : 1
},
"next_flow" : [ {
"code" : "__virtual_Start__2__Analyse",
"name" : "",
"description" : null,
"extra_config" : null,
"from_code" : "Start",
"to_code" : "Analyse"
}, {
"code" : "__virtual_Start__2__Develop",
"name" : "",
"description" : null,
"extra_config" : null,
"from_code" : "Start",
"to_code" : "Develop"
} ],
"fail_result" : null
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询工作项流程信息接口成功的响应。 |
错误码
请参见错误码。