文档首页/ 需求管理 CodeArts Req/ API参考/ API/ Scrum项目的迭代/ 更新当前迭代的启动或结束状态
更新时间:2025-09-11 GMT+08:00
分享

更新当前迭代的启动或结束状态

功能介绍

更新当前迭代的启动或结束状态。

调用方法

请参见如何调用API

URI

POST /v2/version/state/update

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

必传。

取值范围:

最小长度:10,最大长度:32768。

默认取值:

不涉及。

表2 请求Body参数

参数

是否必选

参数类型

描述

-

String

启动或结束迭代的请求体参数。

name

String

参数解释:

当前迭代的名称。

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

id

Integer

参数解释:

当前迭代的唯一标识。通过查询迭代接口获取,响应体中的version字段中的id就是当前迭代id。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

project_id

String

参数解释:

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

约束限制

不涉及。

取值范围

不涉及。

默认取值

不涉及。

status

String

参数解释:

当前项目的状态。

约束限制:

不涉及。

取值范围:

0|1|2

0为将迭代设置为未启动状态

1为启动当前迭代

2的结束当前迭代。

默认取值:

不涉及。

due_date

String

参数解释:

当前迭代的截止日期(时间戳格式,示例:1839340800000)。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

start_date

String

参数解释:

当前项目的开始日期(时间戳格式,示例:1839340800000)。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

result

String

参数解释:

迭代状态的返回结果。

取值范围:

不涉及。

status

String

参数解释:

当前迭代的状态。

取值范围:

success|error,success为成功,error为失败。

请求示例

POST http://{endpoint}/v2/version/state/update

{
  "name" : "333333333",
  "id" : 26658650,
  "project_id" : "ac73924a87d0455ca9b16b0ed15fe367",
  "status" : "0",
  "due_date" : null,
  "start_date" : null
}

响应示例

状态码:200

更新当前迭代的启动或结束状态接口成功的响应。

{
  "result" : "",
  "status" : "success"
}

状态码

状态码

描述

200

更新当前迭代的启动或结束状态接口成功的响应。

错误码

请参见错误码

相关文档