文档首页/ 需求管理 CodeArts Req/ API参考/ API/ Scrum项目的规划/ 更新需求规划
更新时间：2025-08-11 GMT+08:00
在线调试
CLI示例
查看PDF
分享

更新需求规划

功能介绍

更新需求规划。

调用方法

请参见如何调用API。

URI

PUT /v3/plan/{project_id}/management/{plan_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

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

约束限制：

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

取值范围：

不涉及。

默认取值：

不涉及。

plan_id

是

String

参数解释：

发布/迭代唯一Id。可以通过发布/迭代计划列表查询接口获取，响应消息体中的id字段的值就是发布/迭代Id。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

必传。

取值范围：

最小长度：10，最大长度：32768。

默认取值：

不涉及。
表3 请求Body参数

参数

是否必选

参数类型

描述

name

是

String

参数解释：

分组名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

result

result object

参数解释：

规划列表的结果。

status

String

参数解释：

请求的处理状态。

取值范围：

success：成功

error：失败
表5 result

参数

参数类型

描述

id

String

参数解释：

规划的id。

取值范围：

不涉及。

name

String

参数解释：

规划的标题。

取值范围：

不涉及。

type

String

参数解释：

规划类型。

取值范围：

gantt（甘特）

mind（思维导图）

project_id

String

参数解释：

所属项目的id。

取值范围：

不涉及。

creator

creator object

参数解释：

创建人的信息。
表6 creator

参数

参数类型

描述

user_id

String

参数解释：

创建人的用户id。

取值范围：

不涉及。

domain_id

String

参数解释：

租户的id。

取值范围：

不涉及。

nick_name

String

参数解释：

创建人的昵称。

取值范围：

不涉及。

first_name

String

参数解释：

创建人的账户名。

取值范围：

不涉及。

请求示例

PUT https://{endpoint}/v3/plan/919bb351ef424e2daaf3dd80c179fae9/management/bf56512ab4e544c29d03d068711ca56a

{
  "name" : "test"
}

响应示例

状态码：200

更新需求规划响应信息

{
  "result" : {
    "id" : "bf56512ab4e544c29d03d068711ca56a",
    "name" : "test"
  },
  "status" : "success"
}

状态码

状态码

描述

200

更新需求规划响应信息

错误码

请参见错误码。

父主题： Scrum项目的规划

相关文档