更新发布/迭代状态 - ChangePlanStatus

codeartsreq:plan:update

Write

-

• codeartsreq:Model

• codeartsreq:ProjectId

-

-

project_id

是

String

参数解释：

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

约束限制：

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

取值范围：

不涉及。

默认取值：

不涉及。

plan_id

是

String

参数解释：

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

约束限制：

长度为18-19位的数字字符串。

取值范围：

不涉及。

默认取值：

不涉及。

operate

是

String

参数解释：

操作类型。

约束限制：

不涉及。

取值范围：

• start：开始发布/迭代计划

• complete：完成发布/迭代计划

• reset：将计划状态设置为"未开始"

• restart：重新开始发布/迭代计划

• move：将工作项移动到其他迭代

默认取值：

不涉及。

move_to_sprint_id

否

String

参数解释：

将工作项移动到指定迭代ID。operate参数值为complete时，需要将未完成的工作项移动到其他迭代。

约束限制：

operate参数值为complete时需填写。空字符串表示将工作项移动到"待规划"。

取值范围：

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

默认取值：

不涉及。

status

String

参数解释：

返回状态。

取值范围：

• success：操作成功

• error：操作失败

message

String

参数解释：

提示信息。

取值范围：

不涉及。

result

StatusChangeResult object

参数解释：

状态变更结果数据，包含不可完成的工作项信息。

cannot_finish_ar

Array of WorkItemVO objects

参数解释：

不可完成的AR工作项列表，当完成发布/迭代时，未完成的AR工作项会列出在此。

id

String

参数解释：

工作项唯一ID。

取值范围：

不涉及。

title

String

参数解释：

工作项标题。

取值范围：

不涉及。

number

String

参数解释：

工作项编号。

取值范围：

不涉及。

category

String

参数解释：

工作项分类。

取值范围：

不涉及。

status

StatusVO object

参数解释：

工作项状态信息。

assignee

UserVO object

参数解释：

工作项责任人信息。

baseline

String

参数解释：

工作项基线状态。

取值范围：

• baselined：已基线

• unbaseline：未基线

• ""：未基线

change_status

String

参数解释：

工作项变更状态。

取值范围：

• cannot_finish：不可完成

id

String

参数解释：

状态ID。

取值范围：

不涉及。

name

String

参数解释：

状态名称。

取值范围：

不涉及。

id

String

参数解释：

用户ID，32位uuid。

取值范围：

不涉及。

name

String

参数解释：

用户名称。

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述信息。

取值范围：

不涉及。

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

200

更新发布/迭代状态成功

400

Bad Request