更新发布/迭代状态 - ChangePlanStatus
功能介绍
更新发布/迭代状态
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
URI
PUT /v1/planservice/projects/{project_id}/plans/{plan_id}/status
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 参数解释: 项目的32位uuid,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 正则表达式,^[A-Za-z0-9]{32}$。 取值范围: 不涉及。 默认取值: 不涉及。 |
plan_id | 是 | String | 参数解释:发布/迭代唯一Id。可以通过IPD项目计划管理章节中的发布/迭代计划列表查询接口获取,响应消息体中的id字段的值就是发布/迭代Id 约束限制:正则表达式,^([0-9]{18,19})$ 默认取值:不涉及 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
operate | 否 | String | 要进行什么操作 |
move_to_sprint_id | 否 | String | 要移到哪个sprint(空值移动到待规划) |
响应参数
状态码:200
参数 | 参数类型 | 描述 |
|---|---|---|
status | String | 参数解释: 返回状态。 取值范围: success:响应成功 error:响应失败 |
message | String | 信息 |
result | String | 结果 |
状态码:400
参数 | 参数类型 | 描述 |
|---|---|---|
error_msg | String | 错误描述 |
error_code | String | 错误码 |
请求示例
PUT https://{endpoint}/v1/planservice/projects/526cefde62004de2b62b5e8dd2c2b3af/plans/123456789012345678/status
{
"operate" : "move",
"move_to_sprint_id" : "12345678901234567890123456789012"
} 响应示例
状态码:200
OK
{
"status" : "success",
"message" : "查询成功",
"result" : [ {
"id" : "956200745322848257",
"title" : "IR-01",
"category" : "PI",
"description" : "描述",
"state" : "正在工作",
"status" : "ended",
"children" : [ {
"id" : "956239067176935424",
"title" : "子迭代",
"category" : "Iteration",
"description" : "子迭代描述",
"state" : "正在工作",
"status" : "going",
"children" : [ ],
"created_by" : "a360371833bf4c558f796fd707b44daf",
"modified_by" : "a360371833bf4c558f796fd707b44daf",
"plan_start_date" : 1706845715000,
"plan_end_date" : 1706845715000,
"created_date" : 1706845715000,
"parent_id" : "956200745322848257",
"baseline" : "baselined",
"workload" : "10h",
"owner" : "a360371833bf4c558f796fd707b44daf"
} ],
"created_by" : "a360371833bf4c558f796fd707b44daf",
"modified_by" : "a360371833bf4c558f796fd707b44daf",
"plan_start_date" : 1706845715000,
"plan_end_date" : 1706845715000,
"created_date" : 1706845715000,
"parent_id" : "",
"baseline" : "baselined",
"workload" : "20h",
"owner" : "a360371833bf4c558f796fd707b44daf"
} ]
} 状态码:400
Bad Request
{
"status" : "error",
"message" : "错误信息描述,例如参数错误等",
"error_code" : "具体错误码,可根据业务定义",
"error_description" : "更详细的错误说明"
} 状态码
状态码 | 描述 |
|---|---|
200 | OK |
400 | Bad Request |
错误码
请参见错误码。

