查询迭代列表 - QueryVersions

功能介绍

查询迭代列表。

调用方法

请参见如何调用API。

授权信息

当前API调用无需身份策略权限。

URI

GET /v4/projects/{project_id}/versions

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：项目的32位uuid，项目唯一标识，通过查询项目列表接口获取，响应消息体中的project_id字段的值就是项目ID。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

请求参数

无

响应参数

状态码：200

表2 响应Body参数
参数	参数类型	描述
result	result object	参数解释：迭代查询的返回结果。
status	String	参数解释：当前迭代列表响应的状态。取值范围： success：响应成功 error：响应失败

表3 result
参数	参数类型	描述
versions	Array of versions objects	参数解释：返回的迭代列表。
total_count	Integer	参数解释：总的迭代列表的数量。取值范围：不涉及。

表4 versions
参数	参数类型	描述
id	Integer	参数解释：迭代的唯一标识。取值范围：不涉及。
name	String	参数解释：迭代的名称。取值范围：不涉及。
status	String	参数解释：迭代的当前状态。取值范围： 0：未启动 1：进行中 2：已结束
project_id	String	参数解释：迭代所属项目的唯一标识。取值范围：不涉及。
due_date	String	参数解释：迭代的截止日期。（时间戳格式：1756656000000）取值范围：不涉及。
effective_date	String	参数解释：迭代的生效日期。（时间戳格式：1756656000000）取值范围：不涉及。
created_on	String	参数解释：迭代的创建时间。（时间戳格式：1756656000000）取值范围：不涉及。
updated_on	String	参数解释：迭代的最后更新时间。（时间戳格式：1756656000000）取值范围：不涉及。
start_date	String	参数解释：迭代的开始日期（时间戳格式：1756656000000）取值范围：不涉及。
is_current	String	参数解释：该迭代是否为当前版本。取值范围：不涉及。
program_version_id	String	参数解释：关联的程序版本id。取值范围：不涉及。
done_ratio	Integer	参数解释：迭代完成的进度百分比。取值范围：不涉及。
is_deleted	Integer	参数解释：迭代是否已被删除。取值范围： 0：未删除 1：已删除
status_option	Array of status_option objects	参数解释：迭代的状态选项列表。取值范围：不涉及。
project	project object	参数解释：迭代所属的项目信息。取值范围：不涉及。
issue_info	issue_info object	参数解释：有关迭代相关的问题统计信息。取值范围：不涉及。

表5 status_option
参数	参数类型	描述
id	String	参数解释：迭代状态的id。取值范围：不涉及。
name	String	参数解释：迭代状态的名称。取值范围：不涉及。

表6 project
参数	参数类型	描述
name	String	参数解释：迭代所属项目的名称。取值范围：不涉及。
id	Integer	参数解释：迭代所属项目的id。取值范围：不涉及。

表7 issue_info
参数	参数类型	描述
total	Integer	参数解释：所有问题的总数。取值范围：不涉及。
type_info	Array of strings	参数解释：不同类型的问题统计信息。取值范围：不涉及。
closed	String	参数解释：已关闭的问题数量。取值范围：不涉及。
un_closed	String	参数解释：未关闭的问题数量。取值范围：不涉及。

请求示例

{endpoint}/v4/projects/{5192de5eb435430c8cd41c6ae6028848}/versions

响应示例

状态码：200

OK。

{
  "result" : {
    "versions" : [ {
      "id" : 26664788,
      "name" : "111",
      "status" : "0",
      "project_id" : "35138974",
      "due_date" : "1756656000000",
      "effective_date" : "1756656000000",
      "created_on" : "1754387539000",
      "updated_on" : "1754387539000",
      "start_date" : "1755446400000",
      "is_current" : "3",
      "program_version_id" : "-1",
      "done_ratio" : 0,
      "is_deleted" : 0,
      "status_option" : [ {
        "id" : "0",
        "name" : "未启动"
      }, {
        "id" : "1",
        "name" : "进行中"
      }, {
        "id" : "2",
        "name" : "已结束"
      } ],
      "project" : {
        "name" : "DevOps全流程示例项目XXXX",
        "id" : 35138974
      },
      "issue_info" : {
        "total" : 0,
        "type_info" : [ ],
        "closed" : "0",
        "un_closed" : "0"
      }
    }, {
      "id" : 26664721,
      "name" : "修改迭代名称",
      "status" : "1",
      "sharing" : "none",
      "createFromProgramVersion" : false,
      "project_id" : "35138974",
      "due_date" : "1754064000000",
      "effective_date" : "1754064000000",
      "created_on" : "1754375187000",
      "updated_on" : "1754380989000",
      "start_date" : "1752854400000",
      "is_current" : "1",
      "program_version_id" : "-1",
      "done_ratio" : 0,
      "is_deleted" : 0,
      "status_option" : [ {
        "id" : "0",
        "name" : "未启动"
      }, {
        "id" : "1",
        "name" : "进行中"
      }, {
        "id" : "2",
        "name" : "已结束"
      } ],
      "project" : {
        "name" : "DevOps全流程示例项目XXXX",
        "id" : 35138974
      },
      "issue_info" : {
        "total" : 0,
        "type_info" : [ ],
        "closed" : "0",
        "un_closed" : "0"
      }
    }, {
      "id" : 26658716,
      "name" : "迭代1",
      "status" : "2",
      "sharing" : "none",
      "createFromProgramVersion" : false,
      "project_id" : "35138974",
      "due_date" : "1750348800000",
      "effective_date" : "1750348800000",
      "created_on" : "1753084463000",
      "updated_on" : "1754379665000",
      "start_date" : "1749398400000",
      "is_current" : "2",
      "program_version_id" : "-1",
      "done_ratio" : 100,
      "is_deleted" : 0,
      "status_option" : [ {
        "id" : "0",
        "name" : "未启动"
      }, {
        "id" : "1",
        "name" : "进行中"
      }, {
        "id" : "2",
        "name" : "已结束"
      } ],
      "project" : {
        "name" : "DevOps全流程示例项目XXXX",
        "id" : 35138974
      },
      "issue_info" : {
        "total" : 11,
        "type_info" : [ {
          "total" : 5,
          "name" : "Task",
          "closed" : "5",
          "id" : "2",
          "un_closed" : "0"
        }, {
          "total" : 3,
          "name" : "Bug",
          "closed" : "3",
          "id" : "3",
          "un_closed" : "0"
        }, {
          "total" : 3,
          "name" : "Story",
          "closed" : "3",
          "id" : "7",
          "un_closed" : "0"
        } ],
        "closed" : "11",
        "un_closed" : "0"
      }
    } ],
    "total_count" : 3
  },
  "status" : "success"
}