查询迭代详情 - ShowVersionDetail
功能介绍
查询迭代详情。
调用方法
请参见如何调用API。
授权信息
当前API调用无需身份策略权限。
URI
GET /v2/version/show
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| versionId | 是 | String | 参数解释: 迭代的唯一id。通过查询迭代列表接口获取,响应体中的version字段中的id就是当前迭代id。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 最小长度:10,最大长度:32768。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| result | result object | 参数解释: 返回结果。 |
| status | String | 参数解释: 返回状态。 取值范围: success:返回成功。 error:返回失败。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | Integer | 参数解释: 迭代的唯一id。 取值范围: 不涉及。 |
| projectNumId | Integer | 参数解释: 项目的数字id。 取值范围: 不涉及。 |
| name | String | 参数解释: 迭代的名称。 取值范围: 不涉及。 |
| due_date | String | 参数解释: 迭代的结束时间,时间戳格式(示例:1756310400000)。 取值范围: 不涉及。 |
| start_date | String | 参数解释: 迭代的起始时间,时间戳格式(示例:1756310400000)。 取值范围: 不涉及。 |
| created_on | String | 参数解释: 迭代的创建时间,时间戳格式(示例:1756310400000)。 取值范围: 不涉及。 |
| updated_on | String | 参数解释: 迭代的最后一次更新时间,时间戳格式(示例:1756310400000)。 取值范围: 不涉及。 |
| status | String | 参数解释: 迭代的当前状态。 取值范围: 0:未启动 1:进行中 2:已结束 |
| done_ratio | String | 参数解释: 迭代的完成度。 取值范围: 不涉及。 |
| project | project object | 参数解释: 项目信息。 |
| opened_count | Integer | 参数解释: 迭代下未完成的工作项个数。 取值范围: 不涉及。 |
| closed_count | Integer | 参数解释: 迭代下已完成的工作项个数。 取值范围: 不涉及。 |
| have_task | Boolean | 参数解释: 迭代下是否存在工作项。 取值范围: true:存在工作项 false:不存在工作项 |
| total | Integer | 参数解释: 迭代下的工作项总数。 取值范围: 不涉及。 |
请求示例
GET http://{endpoint}/v2/version/show?versionId=21727203 响应示例
状态码:200
查询迭代详情接口成功的响应。
{
"result" : {
"version" : {
"id" : 21727203,
"projectNumId" : 13096279,
"name" : "test",
"due_date" : "1756310400000",
"created_on" : "1755133939000",
"updated_on" : "1755133939000",
"status" : "0",
"start_date" : "1755100800000",
"done_ratio" : 0,
"project" : {
"name" : "Scrum-TEST-0607",
"id" : 13096279
},
"opened_count" : 0,
"closed_count" : 0,
"have_task" : false,
"total" : 0
}
},
"status" : "success"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询迭代详情接口成功的响应。 |
错误码
请参见错误码。