批量创建工作项
功能介绍
批量创建工作项
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v2/ipdprojectservice/projects/{project_id}/issues/batch
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目id |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
[数组元素] |
是 |
Array of IssueCreateEntity objects |
批量创建的工作项参数,每批最大创建10条 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
title |
是 |
String |
工作项标题 |
description |
是 |
String |
工作项描述字段 |
category |
是 |
String |
工作项类型,系统设备类项目可选值为:RR/SF/IR/SR/AR/Task/Bug,独立软件类项目可选值为:RR/SF/IR/US/Task/Bug,云服务类项目可选值为:RR/Epic/FE/US/Task/Bug。 编辑工作项时,此字段必填、值为当前工作项正确的工作项类型,但不会更新此字段 |
parent_id |
是 |
String |
父工作项id,创建子工作项时必填,其他场景非必填 |
status |
是 |
String |
工作项状态code |
assignee |
是 |
UserEntity object |
工作项责任人。Bug必填。其他工作项类型非必填,默认责任人为当前用户 |
recipient |
否 |
Array of UserEntity objects |
原始需求承接人,当工作项类型为RR时字段必填,其他工作项类型无此字段 |
assigned_cc |
否 |
Array of UserEntity objects |
工作项抄送人,支持多个抄送人。同一工作项最多支持50个抄送人 |
plan_end_date |
否 |
String |
工作项计划结束日期,时间戳 |
workload |
否 |
String |
工作项计划工时,保留一位小数,取值范围为0~999999999.9 |
link |
否 |
String |
工作项关联项id,多个关联项用英文逗号分隔,同一工作项最多支持50个关联项 |
labels |
否 |
Array of LabelEntity objects |
工作项标签 |
custom_fields |
否 |
Array of FieldCodeValuePair objects |
工作项自定义字段映射,用户添加的系统字段也在此列 { "code":"字段code", "value":"字段值" } |
children |
否 |
Array of IssueEntity objects |
工作项的子工作项集合。RR/IR/SR/Task有此字段 |
ir2feature |
否 |
String |
IR和SF/FE的关联字段,IR有此字段 |
priority |
否 |
String |
工作项优先级,RR/SF/FE/IR/SR/AR/Task/Bug有此字段 |
related_network_security |
否 |
String |
是否涉及网络安全。仅研发需求有此字段 |
collaboratives |
否 |
String |
研发需求协同信息,协同任务Id. IR/SR/AR/US有此字段 |
business_domain |
否 |
String |
领域字段, FE,SF/IR/SR/AR/Bug有此字段 |
plan_pi |
否 |
String |
工作项发布(老版本名为PI) Id,默认SR/AR/US/Task/Bug有此字段 |
submitted_by |
否 |
Array of UserEntity objects |
工作项提出人,仅RR/Bug有此字段 |
ir2rr |
否 |
String |
IR关联的RR Id(仅IR有此字段),多选时用英文逗号分隔 |
feature_set |
否 |
String |
特性集Id,仅SF/FE有此字段 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
否 |
String |
工作项id |
title |
否 |
String |
工作项标题 |
description |
否 |
String |
工作项描述字段 |
type |
否 |
String |
工作项大分类定义 requirement(研发需求)、bug(缺陷)、task(任务)、feature(特性)、raw_requirement(原始需求) |
number |
否 |
String |
工作项编号 |
category |
否 |
String |
工作项类型,系统设备类项目可选值为:RR/SF/IR/SR/AR/Task/Bug,独立软件类项目可选值为:RR/SF/IR/US/Task/Bug,云服务类项目可选值为:RR/Epic/FE/US/Task/Bug。 编辑工作项时,此字段必填、值为当前工作项正确的工作项类型,但不会更新此字段 |
parent_id |
否 |
String |
父工作项id |
project_id |
否 |
String |
工作项所属的项目id |
status |
否 |
String |
工作项状态code |
assignee |
否 |
UserEntity object |
工作项责任人 |
assigned_cc |
否 |
Array of UserEntity objects |
工作项抄送人,支持多个抄送人。同一工作项最多支持50个抄送人 |
created_by |
否 |
UserEntity object |
工作项创建人 |
created_time |
否 |
String |
工作项创建时间 |
modified_by |
否 |
UserEntity object |
工作项最近更新人 |
modified_time |
否 |
String |
工作项最近更新时间 |
plan_end_date |
否 |
String |
工作项计划结束日期,时间戳 |
close_time |
否 |
String |
工作项关闭时间 |
workload |
否 |
String |
工作项计划工时,保留一位小数,取值范围为0~999999999.9 |
link |
否 |
String |
工作项关联项id,多个关联项用英文逗号分隔,同一工作项最多支持50个关联项 |
suspended |
否 |
Boolean |
工作项是否已挂起 |
status_modified_time |
否 |
String |
工作项状态改变时间,可用于计算工作项在当前状态停留天数 |
labels |
否 |
Array of LabelEntity objects |
工作项标签 |
custom_fields |
否 |
Array of FieldCodeValuePair objects |
工作项自定义字段映射,用户添加的系统字段也在此列 { "code":"字段code", "value":"字段值" } |
children |
否 |
Array of IssueEntity objects |
工作项的子工作项集合 |
ir2feature |
否 |
String |
IR和FE的关联字段,工作项类型为IR时,有此字段 |
need_break |
否 |
String |
工作项是否需要分解,仅可以分解的工作项类型有此字段 |
break_status |
否 |
String |
分解状态 已分解—decomposed 未分解—undecomposed 不涉及— -- |
baseline |
否 |
String |
工作项基线状态 未基线 —— null 已基线 —— baselined 基线评审中——baseline-reviewing |
priority |
否 |
String |
工作项优先级,部分工作项有此字段 |
related_network_security |
否 |
String |
是否涉及网络安全。预设字段中,仅研发需求有此字段 |
collaboratives |
否 |
String |
研发需求协同信息,协同任务id |
business_domain |
否 |
String |
领域字段 |
plan_pi |
否 |
String |
工作项发布(老版本名为PI) id |
plan_iteration |
否 |
String |
工作项完成的迭代,在Bug中为修复迭代 |
change_status |
否 |
String |
工作项变更状态 变更评审中——change-reviewing 已变更——changed 未变更-unchange或null |
no_break_reason |
否 |
String |
无需分解原因,need_break=no时有此字段 |
submitted_by |
否 |
Array of UserEntity objects |
工作项提出人 |
ir2rr |
否 |
String |
IR关联的RR id,多选时用英文逗号分隔 |
feature_set |
否 |
String |
特性集id |
expected_repair_date |
否 |
String |
期望修复时间。预设字段中,仅Bug有此字段 |
found_pi |
否 |
String |
缺陷发现发布。预设字段中,仅Bug有此字段 |
found_iteration |
否 |
String |
缺陷发现迭代。预设字段中,仅Bug有此字段 |
reason_analysis |
否 |
String |
分析原因。预设字段中,仅Bug有此字段 |
repair_solution |
否 |
String |
修复方案。预设字段中,仅Bug有此字段 |
test_report |
否 |
String |
测试报告。预设字段中,仅Bug有此字段 |
sys_no_repair_reason |
否 |
String |
无需修复原因。预设字段中,仅Bug有此字段 |
sys_activation_reason |
否 |
String |
激活原因。预设字段中,仅Bug有此字段 |
sys_return_reason |
否 |
String |
退回原因。预设字段中,仅Bug有此字段 |
test_failures_times |
否 |
Integer |
回归不通过次数。预设字段中,仅Bug有此字段 |
close_type |
否 |
String |
关闭类型。预设字段中,仅Bug有此字段;可选值为 问题解决关闭,问题转需求关闭,重复问题关闭,非问题关闭 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
result |
Array of IssueEntity objects |
创建的工作项返回值 |
status |
String |
操作状态 |
message |
String |
失败原因 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
工作项id |
title |
String |
工作项标题 |
description |
String |
工作项描述字段 |
type |
String |
工作项大分类定义 requirement(研发需求)、bug(缺陷)、task(任务)、feature(特性)、raw_requirement(原始需求) |
number |
String |
工作项编号 |
category |
String |
工作项类型,系统设备类项目可选值为:RR/SF/IR/SR/AR/Task/Bug,独立软件类项目可选值为:RR/SF/IR/US/Task/Bug,云服务类项目可选值为:RR/Epic/FE/US/Task/Bug。 编辑工作项时,此字段必填、值为当前工作项正确的工作项类型,但不会更新此字段 |
parent_id |
String |
父工作项id |
project_id |
String |
工作项所属的项目id |
status |
String |
工作项状态code |
state |
String |
工作项的生命周期,可选值为"正在工作","作废" |
assignee |
UserEntity object |
工作项责任人 |
assigned_cc |
Array of UserEntity objects |
工作项抄送人,支持多个抄送人。同一工作项最多支持50个抄送人 |
created_by |
UserEntity object |
工作项创建人 |
created_time |
String |
工作项创建时间 |
modified_by |
UserEntity object |
工作项最近更新人 |
modified_time |
String |
工作项最近更新时间 |
plan_end_date |
String |
工作项计划结束日期,时间戳 |
close_time |
String |
工作项关闭时间 |
workload |
String |
工作项计划工时,保留一位小数,取值范围为0~999999999.9 |
workload_sum |
String |
工作项计划工时,保留一位小数,取值范围为0~999999999.9,不可编辑 |
tenant_id |
String |
工作项所属租户id |
link |
String |
工作项关联项id,多个关联项用英文逗号分隔,同一工作项最多支持50个关联项 |
suspended |
Boolean |
工作项是否已挂起 |
status_modified_time |
String |
工作项状态改变时间,可用于计算工作项在当前状态停留天数 |
labels |
Array of LabelEntity objects |
工作项标签 |
custom_fields |
Array of FieldCodeValuePair objects |
工作项自定义字段映射,用户添加的系统字段也在此列 { "code":"字段code", "value":"字段值" } |
children |
Array of IssueEntity objects |
工作项的子工作项集合 |
path |
String |
子工作项的路径 |
ir2feature |
String |
IR和FE的关联字段,工作项类型为IR时,有此字段 |
need_break |
String |
工作项是否需要分解,仅可以分解的工作项类型有此字段 |
break_status |
String |
分解状态 已分解—decomposed 未分解—undecomposed 不涉及— -- |
baseline |
String |
工作项基线状态 未基线 —— null 已基线 —— baselined 基线评审中——baseline-reviewing |
priority |
String |
工作项优先级,部分工作项有此字段 |
related_network_security |
String |
是否涉及网络安全。预设字段中,仅研发需求有此字段 |
collaboratives |
String |
研发需求协同信息,协同任务id |
business_domain |
String |
领域字段 |
plan_pi |
String |
工作项发布(老版本名为PI) id |
plan_iteration |
String |
工作项完成的迭代,在Bug中为修复迭代 |
change_status |
String |
工作项变更状态 变更评审中——change-reviewing 已变更——changed 未变更-unchange或null |
no_break_reason |
String |
无需分解原因,need_break=no时有此字段 |
submitted_by |
Array of UserEntity objects |
工作项提出人 |
ir2rr |
String |
IR关联的RR id,多选时用英文逗号分隔 |
feature_set |
String |
特性集id |
expected_repair_date |
String |
期望修复时间。预设字段中,仅Bug有此字段 |
found_pi |
String |
缺陷发现发布。预设字段中,仅Bug有此字段 |
found_iteration |
String |
缺陷发现迭代。预设字段中,仅Bug有此字段 |
reason_analysis |
String |
分析原因。预设字段中,仅Bug有此字段 |
repair_solution |
String |
修复方案。预设字段中,仅Bug有此字段 |
test_report |
String |
测试报告。预设字段中,仅Bug有此字段 |
sys_no_repair_reason |
String |
无需修复原因。预设字段中,仅Bug有此字段 |
sys_activation_reason |
String |
激活原因。预设字段中,仅Bug有此字段 |
sys_return_reason |
String |
退回原因。预设字段中,仅Bug有此字段 |
test_failures_times |
Integer |
回归不通过次数。预设字段中,仅Bug有此字段 |
close_type |
String |
关闭类型。预设字段中,仅Bug有此字段;可选值为 问题解决关闭,问题转需求关闭,重复问题关闭,非问题关闭 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
标签id |
label_type |
String |
标签所属工作项类型,对应工作项的type字段 |
color |
String |
标签颜色RGB |
title |
String |
标签标题 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
批量创建研发需求
{endpoint}/v2/ipdprojectservice/projects/8e70d806a8f04d018ea6af6b6ffe7b96/issues/batch [ { "ir2rr" : "956559072707911681", "category" : "IR", "submitted_by" : [ { "id" : "a360371833bf4c558f796fd707b44daf" }, { "id" : "a360371833bf4c558f796fd707b44dwf" } ], "description" : "<p>【需求背景】</p><p><br></p><p>【需求价值】</p><p><br></p><p>【需求详情】</p>", "title" : "IR-18-分解", "assignee" : { "id" : "a360371833bf4c558f796fd707b44daf" }, "priority" : "中", "plan_pi" : "", "plan_end_date" : "1706630400000", "business_domain" : "software", "assigned_cc" : [ { "id" : "a360371833bf4c558f796fd707b44daf" } ], "custom_fields" : [ { "code" : "done_ratio", "value" : "" }, { "code" : "c7073388365101674496", "value" : "881467547473321986" }, { "code" : "c7148504958125613056", "value" : "" }, { "code" : "module", "value" : "" }, { "code" : "c7148512434669625344", "value" : "956591616891461634" } ] } ]
响应示例
状态码: 200
OK
{ "status" : "success", "result" : [ { "category" : "IR", "id" : "974703074900615168", "title" : "IR-18-分解", "description" : "<p>【需求背景】</p><p><br></p><p>【需求价值】</p><p><br></p><p>【需求详情】</p>", "type" : "requirement", "number" : "IR20240313680650", "project_id" : "8e70d806a8f04d018ea6af6b6ffe7b96", "status" : "Start", "state" : "正在工作", "assignee" : { "id" : "a360371833bf4c558f796fd707b44daf", "name" : "devcloud_devcloud_s00404480_01", "nick_name" : "测试账号123" }, "assigned_cc" : [ { "id" : "a360371833bf4c558f796fd707b44daf", "name" : "devcloud_devcloud_s00404480_01", "nick_name" : "测试账号123" } ], "created_by" : { "id" : "a360371833bf4c558f796fd707b44daf", "name" : "devcloud_devcloud_s00404480_01", "nick_name" : "测试账号123" }, "created_time" : "1710316922000", "modified_by" : { "id" : "a360371833bf4c558f796fd707b44daf", "name" : "devcloud_devcloud_s00404480_01", "nick_name" : "测试账号123" }, "modified_time" : "1710316922000", "workload" : "20.0", "tenant_id" : "4e919d73499648e3b0292cd3cbef806a", "status_modified_time" : "1710316922000", "custom_fields" : [ { "code" : "c7073388365101674496", "value" : "881467547473321986" }, { "code" : "c7148512434669625344", "value" : "956591616891461634" } ], "need_break" : "yes", "break_status" : "undecomposed", "priority" : "中", "related_network_security" : "no", "business_domain" : "software", "plan_pi" : "", "no_break_reason" : "", "submitted_by" : [ { "id" : "a360371833bf4c558f796fd707b44daf", "name" : "devcloud_devcloud_s00404480_01", "nick_name" : "测试账号123" }, null ], "ir2rr" : "956559072707911681" } ] }
状态码: 400
错误信息
{ "error_msg" : "系统繁忙,请稍后再试", "error_code" : "PM.02175000" }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
错误信息 |
错误码
请参见错误码。