新建计划 - CreatePlans

codeartsreq:plan:create

Write

-

• codeartsreq:Model

• codeartsreq:ProjectId

-

-

project_id

是

String

参数解释：

项目的32位uuid，项目唯一标识，通过查询项目列表接口获取，响应消息体中的project_id字段的值就是项目ID。

约束限制：

32个字符，由英文字母和数字组成。

取值范围：

不涉及。

默认取值：

不涉及。

x-auth-token

是

String

参数解释：

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

约束限制：

不涉及。

取值范围：

长度为10-32768的字符串。

默认取值：

不涉及。

title

是

String

参数解释：

计划标题。

约束限制：

不涉及。

取值范围：

1~256个字符。

默认取值：

不涉及。

category

是

String

参数解释：

计划分类，枚举类型。

约束限制：

不涉及。

取值范围：

• PI：发布

• Iteration：迭代

• PlanMilestone：里程碑

默认取值：

不涉及。

description

否

String

参数解释：

计划描述信息。

约束限制：

不涉及。

取值范围：

0~1000个字符。

默认取值：

不涉及。

plan_start_date

是

String

参数解释：

计划开始时间，格式为yyyy-MM-dd，如2024-01-01。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

plan_end_date

是

String

参数解释：

计划完成时间，格式为yyyy-MM-dd，如2024-01-01。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

parent_id

否

String

参数解释：

父计划ID，当category为Iteration时必填，用于指定所属的发布计划。

约束限制：

category为Iteration时必填。

取值范围：

长度为18~19个字符的数字字符串。

默认取值：

不涉及。

workload

否

String

参数解释：

预估工作量，用于标识计划所需的人力投入，单位人/天。

约束限制：

不涉及。

取值范围：

0~11个字符。

默认取值：

不涉及。

owner

否

String

参数解释：

责任人ID，标识计划的负责人。

约束限制：

不涉及。

取值范围：

长度为32个字符。

默认取值：

不涉及。

status

String

参数解释：

返回状态。

取值范围：

• success：操作成功

• error：操作失败

message

String

参数解释：

提示信息。

取值范围：

不涉及。

result

PlanResponseResult object

参数解释：

计划详情数据，包含发布/迭代的完整信息。

id

String

参数解释：

发布、迭代、里程碑的ID

取值范围：

不涉及

title

String

参数解释：

标题

取值范围：

不涉及

category

String

参数解释：

分类，枚举类型

取值范围：

• PI：发布

• Iteration：迭代

• PlanMilestone：里程碑

description

String

参数解释：

描述

取值范围：

不涉及

state

String

参数解释：

作废标识，枚举类型。

取值范围：

• 正在工作：可正常操作的发布。

• 作废：软删除后的发布。

• 删除：彻底删除后的发布。

status

String

参数解释：

发布/迭代的状态，枚举类型。

取值范围：

• planned：发布/计划未开始

• going：发布/计划进行中

• ended：发布/计划已结束

children

Array of PlanResponseResult objects

参数解释：

子项目迭代信息

created_by

String

参数解释：

创建人ID

取值范围：

不涉及

modified_by

String

参数解释：

最近更新人ID。

取值范围：

不涉及

plan_start_date

Long

参数解释：

计划开始时间，unix时间戳，单位：毫秒。

取值范围：

不涉及

plan_end_date

Long

参数解释：

计划完成时间，unix时间戳，单位：毫秒。

取值范围：

不涉及

created_date

Long

参数解释：

创建时间，unix时间戳，单位：毫秒

取值范围：

不涉及

parent_id

String

参数解释：

父计划ID，当计划类型为迭代(Iteration)时，用于指定所属的发布计划。

取值范围：

长度为18~19个字符的数字字符串。

baseline

String

参数解释：

基线状态，枚举类型，标识计划是否已纳入基线管理。

取值范围：

• baselined：已基线

• unbaseline：未基线

• ""：未基线

workload

String

参数解释：

预估工作量，用于标识计划所需的人力或时间投入，单位人/天。

取值范围：

最大长度11个字符。

owner

String

参数解释：

责任人ID，标识计划的负责人。

取值范围：

长度为32位的字符串。

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述信息。

取值范围：

不涉及。

200

新建计划成功

400

错误信息