创建IPD工作项
功能介绍
创建IPD项目工作项。
调用方法
请参见如何调用API。
URI
POST /v1/ipdprojectservice/projects/{project_id}/issues
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目的32位uuid,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 正则表达式,^[A-Za-z0-9]{32}$。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 最小长度:10,最大长度:32768。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
title |
是 |
String |
参数解释: 工作项标题。 约束限制: 正则表达式:[\s\S]{1,256}。 取值范围: 最大长度256位。 默认取值: 不涉及。 |
description |
是 |
String |
参数解释: 工作项描述字段。 约束限制: 正则表达式:[\s\S]{0,500000}。 取值范围: 最大字段长度:500000位。 默认取值: 不涉及。 |
status |
否 |
String |
参数解释: 工作项状态code。 约束限制: 正则表达式:([A-Z_][A-Za-z_]{2,20}|\S{18,32}|s\d{19,30})。 取值范围: Committed(保存); Analyse(分析); ToBeConfirmed(确认); Plan(规划); Doing(实现); Delivered(交付); Checking(验收)。 默认取值: 不涉及。 |
src_domain |
否 |
String |
参数解释: 提出项目的租户ID,通过获取当前用户信息接口查询用户对应的租户信息。 约束限制: 正则表达式,[A-Za-z0-9]{32}。 取值范围: 不涉及。 默认取值: 不涉及。 |
submitted_by |
否 |
String |
参数解释: 提交人Id。用户通过获取当前用户信息接口获取,响应消息体中的user_id字段的值就是用户32位uuid。 约束限制: 正则表达式:"[0-9a-z]{32}"。 取值范围: 不涉及。 默认取值: |
domain_id |
否 |
String |
参数解释: 归属项目的租户ID,通过获取当前用户信息接口查询用户对应的租户信息。 约束限制: 正则表达式,[A-Za-z0-9]{32}。 取值范围: 不涉及。 默认取值: 不涉及。 |
recipient |
否 |
Array of strings |
参数解释: 承接人id。用户通过获取当前用户信息接口获取,响应消息体中的user_id字段的值就是用户32位uuid。 约束限制: 正则表达式:"[0-9a-z]{32}"。 |
expect_delivery_time |
否 |
Long |
参数解释: 期望完成时间。 约束限制: 不涉及。 取值范围: 时间戳。 默认取值: 不涉及。 |
priority |
否 |
String |
参数解释: 优先级。用户通过查询字段列表接口获取,响应消息体中优先级的option字段的值就是密级字段的可选值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
assigned_cc |
否 |
Array of strings |
参数解释: 工作项抄送人,支持多个抄送人。 约束限制: 同一工作项最多支持50个抄送人。 |
category |
是 |
String |
参数解释: 工作项类型。编辑工作项时,此字段必填、值为当前工作项正确的工作项类型,但不会更新此字段。 约束限制: 正则表达式:[A-Z_]{2,20}。 取值范围: 系统设备类项目可选值为:RR、SF、IR、SR、AR、Task、Bug; 独立软件类项目可选值为:RR、SF、IR、US、Task、Bug; 云服务类项目可选值为:RR、Epic、FE、US、Task、Bug。 默认取值: |
assignee |
是 |
String |
参数解释: 工作项责任人。用户通过获取当前用户信息接口获取,响应消息体中的user_id字段的值就是用户32位uuid。 约束限制: 正则表达式:[A-Za-z0-9]{32}。 取值范围: 不涉及。 默认取值: 不涉及。 |
plan_pi |
否 |
String |
参数解释: 工作项发布计划Id。 约束限制: 默认SR、AR、US、Task、Bug有此字段。 取值范围: 不涉及。 默认取值: 不涉及。 |
plan_iteration |
否 |
String |
参数解释: 工作项完成的迭代计划id,可通过查询树状工作项接口获取,响应消息体中的plan_iteration字段的值就是迭代计划id。 约束限制: 正则表达式,^([0-9]{18,19})$。 取值范围: 不涉及。 默认取值: 不涉及。 |
plan_start_date |
否 |
Long |
参数解释: 工作项计划结束日期。 约束限制: 正则表达式:-?[0-9]{0,13}。 取值范围: 时间戳。 默认取值: 不涉及。 |
plan_end_date |
否 |
Long |
参数解释: 工作项计划结束日期。 约束限制: 正则表达式:-?[0-9]{0,13}。 取值范围: 时间戳。 默认取值: 不涉及。 |
workload_man_day |
否 |
Integer |
参数解释: 工作项计划工时。 约束限制: 正则表达式:([0-9]{1,8}([.][0-9])?)。 取值范围: 保留一位小数,取值范围为0~999999999.9。 默认取值: 不涉及。 |
business_domain |
否 |
String |
参数解释: 领域,可以通过查询字段列表接口获取,响应消息体中领域的option字段的值就是领域字段的可选值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
need_break |
否 |
String |
参数解释: 是否需要分解。可以通过查询字段列表接口获取,响应消息体中是否需要分解的option字段的值就是是否需要分解字段的可选值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
status |
String |
参数解释: 状态 取值范围: 不涉及 |
message |
String |
参数解释: 信息 取值范围: 不涉及 |
result |
Array of IssueDetailsResponse objects |
参数解释: 查询结果 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: 工作项ID。 取值范围: 不涉及。 |
number |
String |
参数解释: 工作项编号。 取值范围: 不涉及。 |
type |
String |
参数解释: 工作项类型。 取值范围: 不涉及。 |
stay_days |
Integer |
参数解释: 停留天数。 取值范围: 不涉及。 |
tenant_id |
String |
参数解释: 租户ID。 取值范围: 不涉及。 |
created_date |
String |
参数解释: 工作项创建时间。 取值范围: 不涉及。 |
title |
String |
参数解释: 工作项标题。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: 密级字段id。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
display_value |
String |
参数解释: 密级字段名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
value |
String |
参数解释: 用户自定义的密级字段的值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 value: |
code |
String |
参数解释: 密级编码。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
sequence |
Double |
参数解释: 密级排序值,越大级别越高 |
请求示例
-
/v1/ipdprojectservice/projects/{project_id}/issues { "status" : "Analyse", "title" : "模型一原始需求demo", "description" : "<p>【需求背景】</p><p><br></p><p>【需求价值】</p><p><br></p><p>【需求详情】</p>", "src_domain" : "868551927720357888", "submitted_by" : "a360371833bf4c558f796fd707b44daf", "domain_id" : "868551927720357888", "assignee" : "eab51c9c46f84d3aab838e1db6401232", "recipient" : [ "a360371833bf4c558f796fd707b44daf" ], "priority" : "中", "category" : "RR" }
-
/v1/ipdprojectservice/projects/{project_id}/issues { "title" : "模型二初始需求demo", "description" : "<p>【需求背景】</p><p><br></p><p>【需求价值】</p><p><br></p><p>【需求详情】</p>", "domain_id" : "885117755981602818", "status" : "Start", "submitted_by" : "eab51c9c46f84d3aab838e1db6401232", "assignee" : "eab51c9c46f84d3aab838e1db6401232", "priority" : "中", "plan_pi" : "885118532431159297", "plan_iteration" : "885118693565890561", "plan_start_date" : 1688918400000, "plan_end_date" : 1690214400000, "workload_man_day" : 10, "business_domain" : "software", "need_break" : "yes", "assigned_cc" : [ "eab51c9c46f84d3aab838e1db6401232" ], "category" : "IR" }
-
/v1/ipdprojectservice/projects/{project_id}/issues { "title" : "模型三任务demo", "description" : "<p>【任务背景】</p><p><br></p><p>【任务价值】</p><p><br></p><p>【任务详情】</p>", "domain_id" : "885119056444489729", "status" : "Start", "assignee" : "eab51c9c46f84d3aab838e1db6401232", "priority" : "中", "assigned_cc" : [ "eab51c9c46f84d3aab838e1db6401232" ], "business_domain" : "software", "plan_start_date" : 1688918400000, "plan_end_date" : 1690214400000, "workload_man_day" : 12, "category" : "Task" }
响应示例
状态码:200
创建成功响应
{ "status" : "success", "message" : null, "result" : [ ] }
状态码
状态码 |
描述 |
---|---|
200 |
创建成功响应 |
错误码
请参见错误码。