文档首页/ 需求管理 CodeArts Req/ API参考/ API/ Scrum项目的迭代/ 获取指定项目的迭代列表
更新时间：2024-03-07 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取指定项目的迭代列表

功能介绍

获取项目迭代

调用方法

请参见如何调用API。

URI

GET /v4/projects/{project_id}/iterations

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

devcloud项目的32位id

最小长度：32

最大长度：32
表2 Query参数

参数

是否必选

参数类型

描述

updated_time_interval

否

String

更新迭代的时间(查询的起始时间,查询的结束时间)

include_deleted

否

Boolean

是否包含被删除的迭代,默认false不包含被删除的迭代

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

最小长度：10

最大长度：32768

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

total

Integer

迭代总数

iterations

Array of iterations objects

迭代信息
表5 iterations

参数

参数类型

描述

description

String

迭代描述

end_time

String

迭代结束时间

id

Integer

迭代id

name

String

迭代标题

begin_time

String

迭代开始时间

status

String

迭代状态

updated_time

Long

迭代更新时间，长整型时间戳

deleted

Boolean

迭代是否已经删除，false, 未删除， true已经删除

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

状态码： 401

表7 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

请求示例

Get https://{endpoint}/v4/projects/e2da96a5d2c845e284f0ad47f8ca8cb1/iterations

Get https://{endpoint}/v4/projects/e2da96a5d2c845e284f0ad47f8ca8cb1/iterations

响应示例

状态码： 200

OK

{
  "total" : 3,
  "iterations" : [ {
    "description" : "description",
    "end_time" : "2019-10-17",
    "id" : 9725885,
    "name" : "完成html",
    "begin_time" : "2019-10-10",
    "status" : "0",
    "updated_time" : 1640231944000,
    "deleted" : false
  } ]
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

错误码

请参见错误码。

父主题： Scrum项目的迭代

相关文档