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

查看迭代详情

功能介绍

查看迭代详情

调用方法

请参见如何调用API。

URI

GET /v4/iterations/{iteration_id}

表1 路径参数

参数

是否必选

参数类型

描述

iteration_id

是

Integer

迭代id

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

最小长度：10

最大长度：32768

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

begin_time

String

迭代结束时间，年-月-日

charts

Array of Chart objects

燃尽图

closed_total

Integer

已关闭的工单数

created_time

String

迭代创建时间

end_time

String

迭代开始时间，年-月-日

have_task

Boolean

是否有task

iteration_id

Integer

迭代id

name

String

迭代标题

opened_total

Integer

开启的工单数

progress

String

工作进展

total

Integer

工单总数

updated_time

String

迭代更新时间

status

String

迭代的状态,0 未开始，1 进行中，2 结束
表4 Chart

参数

参数类型

描述

date

String

统计时间

finished_num

Integer

完成story工单

iteration_id

Integer

迭代id

project_num_id

Integer

项目id

remaining_num

Integer

未完成story数

total

Integer

总story数

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

状态码： 401

表6 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

请求示例

Get https://{endpoint}/v4/iterations/11225793

Get https://{endpoint}/v4/iterations/11225793

响应示例

状态码： 200

OK

{
  "begin_time" : "2020-07-12",
  "charts" : [ {
    "date" : "2020-09-12",
    "finished_num" : 1,
    "iteration_id" : 3789,
    "project_num_id" : 36587463,
    "remaining_num" : 3,
    "total" : 4
  } ],
  "closed_total" : 1,
  "created_time" : "2020-06-31 09:10:03",
  "end_time" : "2020-07-19",
  "have_task" : false,
  "iteration_id" : 35789,
  "name" : "迭代1",
  "opened_total" : 3,
  "progress" : "25%",
  "total" : 4,
  "updated_time" : "2020-06-31 09:10:03",
  "status" : "0"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

错误码

请参见错误码。

父主题： Scrum项目的迭代

相关文档