文档首页/ 需求管理 CodeArts Req/ API参考/ API/ IPD项目计划管理/ 新建计划 - CreatePlans
更新时间：2026-02-13 GMT+08:00
在线调试
CLI示例
查看PDF
分享

新建计划 - CreatePlans

功能介绍

新建计划（里程碑、发布、迭代）

调用方法

请参见如何调用API。

授权信息

账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

codeartsreq:plan:create

Write

-

  • codeartsreq:Model

  • codeartsreq:ProjectId

-

-

URI

POST /v1/planservice/projects/{project_id}/plans

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

正则表达式，^[A-Za-z0-9]{32}$。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

x-auth-token

是

String

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

约束限制：不涉及

取值范围：最小长度10，最大长度：32768

默认取值：不涉及
表3 请求Body参数

参数

是否必选

参数类型

描述

title

是

String

参数解释：

标题

取值范围：

不涉及

category

是

String

参数解释：

分类，枚举类型

取值范围：

PI，Iteration，PlanMilestone

description

否

String

参数解释：

描述

取值范围：

不涉及

plan_start_date

是

String

参数解释：

计划开始时间，"yyyy-MM-dd"格式

取值范围：

不涉及

plan_end_date

是

String

参数解释：

计划完成时间，"yyyy-MM-dd"格式

取值范围：

不涉及

parent_id

否

String

参数解释：

父工作项id，当category=Iteration时必填

取值范围：

不涉及

workload

否

String

参数解释：

预估工作量

取值范围：

不涉及

owner

否

String

参数解释：

责任人ID

取值范围：

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

status

String

参数解释：

返回状态。

取值范围：

success：响应成功

error：响应失败

message

String

提示信息

result

PlanVO object

创建的计划返回值
表5 PlanVO

参数

参数类型

描述

id

String

参数解释：

id（发布、迭代、里程碑的id）

取值范围：

不涉及

title

String

参数解释：

标题

取值范围：

不涉及

category

String

参数解释：

分类，枚举类型

取值范围：

  • PI：发布

  • Iteration：迭代

  • PlanMilestone：里程碑

description

String

参数解释：

描述

取值范围：

不涉及

state

String

参数解释：

作废标识，枚举类型。

取值范围：

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

  • 作废：软删除后的发布，可在回收站恢复

  • 删除：彻底删除后的发布，无法恢复

status

String

参数解释：

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

取值范围：

  • planned：发布/计划未开始

  • going：发布/计划进行中

  • ended：发布/计划已结束

children

Array of PlanVO objects

参数解释：

子项目迭代信息

created_by

String

参数解释：

创建人Id

取值范围：

不涉及

modified_by

String

参数解释：

最近更新人Id

取值范围：

不涉及

plan_start_date

String

参数解释：

计划开始时间，"yyyy-MM-dd"格式

取值范围：

不涉及

plan_end_date

String

参数解释：

计划完成时间，"yyyy-MM-dd"格式

取值范围：

不涉及

created_date

Long

参数解释：

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

取值范围：

不涉及

parent_id

String

参数解释：

父工作项id

取值范围：

不涉及

baseline

String

参数解释：

基线状态，枚举类型

取值范围：

  • baselined：已基线

  • unbaseline：未基线

  • baseline-reviewing：基线评审中

workload

String

参数解释：

预估工作量

取值范围：

不涉及

owner

String

参数解释：

责任人ID

取值范围：

不涉及

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

  • 新建发布

    POST https://{endpoint}/v1/planservice/projects/2a0d6799fe0d48b29ab8710be556d461/plans

{
  "title" : "plan_0731_1",
  "category" : "PI",
  "plan_end_date" : "2025-01-20",
  "plan_start_date" : "2025-02-01"
}

  • 新建迭代

    https://{endpoint}/v1/planservice/projects/2a0d6799fe0d48b29ab8710be556d461/plans

{
  "title" : "iteration_0731_1",
  "category" : "Iteration",
  "plan_end_date" : "2025-01-20",
  "plan_start_date" : "2025-02-01",
  "parent_id" : "1088833093706829825"
}

响应示例

状态码：200

OK

{
  "status" : "success",
  "message" : "计划创建成功",
  "result" : {
    "id" : "123e4567e89b12d3a456426614174000",
    "title" : "项目里程碑1",
    "category" : "PlanMilestone",
    "description" : "这是项目的一个重要里程碑",
    "state" : "正在工作",
    "status" : "planned",
    "children" : [ {
      "id" : "123e4567e89b12d3a456426614174000",
      "title" : "迭代1",
      "category" : "Iteration",
      "description" : "迭代1的描述",
      "state" : "正在工作",
      "status" : "planned",
      "children" : [ ],
      "created_by" : "user1",
      "modified_by" : "user1",
      "plan_start_date" : 1633072800000,
      "plan_end_date" : 1635751200000,
      "created_date" : 1633072800000,
      "parent_id" : "123e4567e89b12d3a456426614174000",
      "baseline" : "unbaseline",
      "workload" : "10人天",
      "owner" : "user2"
    } ],
    "created_by" : "admin",
    "modified_by" : "admin",
    "plan_start_date" : 1630466400000,
    "plan_end_date" : 1633072800000,
    "created_date" : 1630466400000,
    "parent_id" : null,
    "baseline" : "unbaseline",
    "workload" : "20人天",
    "owner" : "user1"
  }
}

状态码：400

错误信息

{
  "error_msg" : "Invalid project_id or other parameters",
  "error_code" : "AS.0001"
}

状态码

状态码

描述

200

OK

400

错误信息

错误码

请参见错误码。

父主题： IPD项目计划管理

相关文档