更新迭代V2
功能介绍
更新迭代的名称。
调用方法
请参见如何调用API。
URI
POST /v2/version/update
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 最小长度:10,最大长度:32768。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
due_date |
否 |
Integer |
参数解释: 当前迭代的截止日期(时间戳格式:1757952000000)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
id |
否 |
Integer |
参数解释: 当前迭代的数字id。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
name |
否 |
String |
参数解释: 迭代修改后的名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
start_date |
否 |
Integer |
参数解释: 当前迭代的开始日期(时间戳格式:1757952000000)。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
project_id |
否 |
String |
参数解释: 项目的32位id,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
update_workitem_date |
否 |
Boolean |
参数解释: 是否同步修改改迭代下所有工作项的“预计开始时间/预计结束时间“。 约束限制: 不涉及。 取值范围: true:需要同步 false:不需要同步 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
result |
String |
参数解释: 修改迭代名称返回的结果。 取值范围: 不涉及。 |
status |
String |
参数解释: 修改迭代返回后的状态。 取值范围: success:修改成功 error:修改失败。 |
请求示例
{endpoint}/v2/version/update { "due_date" : 1754064000000, "id" : 26664721, "name" : "test", "start_date" : 1752854400000, "project_id" : "5192de5eb435430c8cd41c6ae6028848", "update_workitem_date" : false }
响应示例
状态码:200
OK。
{ "result" : "", "status" : "success" }
状态码
状态码 |
描述 |
---|---|
200 |
OK。 |
错误码
请参见错误码。