工作项流程批量流转 - BatchTransferWorkItemFlow
功能介绍
工作项流程批量流转
调用方法
请参见如何调用API。
URI
PUT /v1/ipdprojectservice/projects/{project_id}/work-item/processes/transfer-batch
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目的32位uuid,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
is_recover |
否 |
Boolean |
参数解释: 是否覆盖对应字段。 约束限制: 不涉及 取值范围: true:本开关开启时,当前弹窗的相应字段值将覆盖全部所选工作项的对应字段值。 false:本开关关闭时,除「当前责任人」之外,所选工作项的对应字段如果已经有值,将保持原状,不会被当前弹窗的相应字段值覆盖。 默认取值: false。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 最小长度:10,最大长度:32768。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
id |
否 |
String |
参数解释: 工作项唯一Id。可以通过查询工作项列表或者查询树状工作接口获取,响应消息体中的id字段的值就是工作项ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
issue_category |
是 |
String |
参数解释: 工作项类型。 约束限制: 不涉及。 取值范围: RR、IR、AR、SR、Bug、FE、Task、US、Epic、SF 默认取值: 不涉及。 |
|
flow_code |
是 |
String |
参数解释: 工作项流转code。可以通过查询工作项流程信息接口获取。 响应消息体中的next_flow数组为工作流流转线,根据from_code当前状态和to_code目标状态找到匹配的流转线,流转线的code字段的值就是工作项流转code。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
issue_ids |
否 |
Array of strings |
参数解释: 工作项唯一Id数组。可以通过查询工作项列表或者查询树状工作接口获取,响应消息体中的id字段的值就是工作项ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
process_context |
否 |
Map<String,Object> |
参数解释: 流转中配置上下文信息。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
status |
String |
参数解释: 状态码。 取值范围: 不涉及。 |
|
message |
String |
参数解释: 响应信息。 取值范围: 不涉及。 |
|
result |
参数解释: 批量操作基本信息返回体。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
success_num |
Integer |
参数解释: 批量操作成功条数。 取值范围: 不涉及。 |
|
fail_num |
Integer |
参数解释: 批量操作失败条数。 取值范围: 不涉及。 |
|
failed |
Array of IssueWithReasonVO objects |
参数解释: 批量操作失败数据及失败原因。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: 工作项唯一Id。可以通过查询工作项列表或者查询树状工作接口获取,响应消息体中的id字段的值就是工作项ID。 取值范围: 不涉及。 |
|
category |
String |
参数解释: 工作项类型。 取值范围: 系统设备类项目可选值为:RR/SF/IR/SR/AR/Task/Bug,独立软件类项目可选值为:RR/SF/IR/US/Task/Bug,云服务类项目可选值为:RR/Epic/FE/US/Task/Bug。 |
|
title |
String |
参数解释: 工作项标题。 取值范围: 不涉及。 |
|
number |
String |
参数解释: 工作项唯一编码number。 取值范围: 不涉及。 |
|
reason |
String |
参数解释: 操作失败原因。 取值范围: 不涉及。 |
请求示例
批量流转缺陷并覆盖对应字段。
PUT /v1/ipdprojectservice/projects/e5c9c13a20a7495a8237c8e81471c8c7/work-item/processes/transfer-batch?is_recover=true
{
"issue_ids" : [ "1167829636360347649" ],
"issue_category" : "Bug",
"flow_code" : "Analyse2Fixed",
"process_context" : {
"attach_work_item_attribute_validator" : {
"assignee" : "09d25f5d3f80d2881fd7c008ecf1622b",
"reason_analysis" : "<p><span style=\"font-size: 14px; color: rgb(25, 25, 25);\">分析原因</span></p>"
},
"attach_flow_attribute_validator" : { }
}
}
响应示例
状态码:200
工作项流程批量流转接口成功的响应。
{
"status" : "success",
"message" : null,
"result" : {
"success_num" : 0,
"fail_num" : 1,
"failed" : [ {
"id" : "1096034499808894976",
"category" : "Bug",
"title" : "这是工作项标题",
"number" : "BUG20250211986398",
"reason" : "当前状态已被异步流转,无法流转到目标状态"
} ]
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
工作项流程批量流转接口成功的响应。 |
错误码
请参见错误码。