更新时间:2025-08-11 GMT+08:00
分享

创建迭代V2

功能介绍

创建迭代。

调用方法

请参见如何调用API

URI

GET /v2/version/create-version

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

必传。

取值范围:

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

默认取值:

不涉及。

表2 请求Body参数

参数

是否必选

参数类型

描述

start_date

Integer

参数解释:

创建的迭代的开始日期(时间戳格式:1754150400000)。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

due_date

Integer

参数解释:

创建的迭代的截止日期(时间戳格式:1754150400000)。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

project_id

String

参数解释

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

约束限制

不涉及。

取值范围:

不涉及。

默认取值

不涉及。

name

String

参数解释:

创建迭代的名称。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

result

result object

参数解释:

创建迭代的返回结果。

status

String

参数解释:

当前创建迭代的响应状态。

取值范围:

不涉及。

表4 result

参数

参数类型

描述

version

version object

参数解释:

当前创建迭代的版本信息。

表5 version

参数

参数类型

描述

id

Integer

参数解释:

创建的迭代的唯一id。

取值范围:

不涉及。

project_num_id

Integer

参数解释:

当前迭代关联的项目的唯一id。

取值范围:

不涉及。

project_id

String

参数解释:

当前迭代所属项目的唯一id。

取值范围:

不涉及。

name

String

参数解释:

创建的迭代的名称。

取值范围:

不涉及。

due_date

String

参数解释:

创建的迭代的截止日期。

取值范围:

不涉及。

effective_date

String

参数解释:

当前创建的迭代的生效日期。

取值范围:

不涉及。

status

String

参数解释:

当前迭代的状态。

取值范围:

0:未启动。

sharing

String

参数解释:

当前迭代的分享状态,是否对外分享。

取值范围:

none:不分享。

start_date

String

参数解释:

当前迭代的开始日期。

取值范围:

不涉及。

done_ratio

Integer

参数解释:

当前迭代的完成进度。

取值范围:

不涉及。

请求示例

{endpoint}/v2/version/create-version?_=1753067241950

{
  "start_date" : 1752854400000,
  "due_date" : 1754064000000,
  "project_id" : "5192de5eb435430c8cd41c6ae6028848",
  "name" : "test"
}

响应示例

状态码:200

OK。

{
  "result" : {
    "version" : {
      "id" : 26664721,
      "project_num_id" : 35138974,
      "project_id" : "5192de5eb435430c8cd41c6ae6028848",
      "name" : "新创建迭代",
      "due_date" : "2025-08-02",
      "effective_date" : "2025-08-02",
      "status" : "0",
      "sharing" : "none",
      "start_date" : "2025-07-19",
      "done_ratio" : 0
    }
  },
  "status" : "success"
}

状态码

状态码

描述

200

OK。

错误码

请参见错误码

相关文档