获取统计面板数据
功能介绍
获取需求/缺陷统计面板数据,数据会有5~10分钟延迟。
调用方法
请参见如何调用API。
URI
POST /v1/ipdprojectservice/projects/{project_id}/statistic/dashboard
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目的32位uuid,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
classification |
是 |
String |
参数解释: 标识统计类型。 约束限制: 正则表达式:(requirement|bug)。 取值范围: requirement,bug。 classification=requirement,查询需求统计; classification=bug,查询缺陷统计。 默认取值: 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 最小长度:10,最大长度:32768。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
plan |
否 |
PlanFilter object |
参数解释: 发布计划过滤条件。 约束限制: 不涉及。 |
|
created_date |
否 |
DateFilter object |
参数解释: 工作项创建时间过滤条件。 约束限制: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
plan_pi |
否 |
String |
参数解释: 按发布计划统计时,被统计的发布计划的id。通过发布/迭代计划列表查询]接口查询发布计划的id,返回参数中PlanVO里面的id字段即发布计划的id。 约束限制: 正则表达式:[0-9]{18,19}。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
plan_iteration |
否 |
String |
参数解释: 按发布计划下迭代计划统计时,迭代计划的id。 约束限制: 正则表达式:[0-9]{18,19}。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
result |
Array of DashboardSimpleVO objects |
参数解释: 统计结果。 |
|
status |
String |
参数解释: 返回状态。 取值范围: success:响应成功 error:响应失败 |
|
message |
String |
参数解释: 请求失败信息。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
category |
String |
参数解释: 工作项类型。 取值范围: 系统设备类项目可选值为:RR/SF/IR/SR/AR/Task/Bug,独立软件类项目可选值为:RR/SF/IR/US/Task/Bug,云服务类项目可选值为:RR/Epic/FE/US/Task/Bug。 |
|
total |
Integer |
参数解释: 工作项总数。 取值范围: 不涉及。 |
|
processing |
Integer |
参数解释: 处理中的工作项数量。 取值范围: 不涉及。 |
|
completed |
Integer |
参数解释: 已完成的工作项数量。 取值范围: 不涉及。 |
|
expired |
Integer |
参数解释: 已超期的工作项数量。 取值范围: 不涉及。 |
|
remain_di |
Double |
参数解释: 缺陷的遗留DI,统计范围为该项目下所有非关闭态、非草稿态的缺陷。 取值范围: DI计算规则: DI=提示0.1 + 一般1 +严重3 + 致命10。 |
|
category_name |
String |
参数解释: 统计面板名称。 取值范围: 不涉及。 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
请求示例
http://localhost:8083/ipdprojectservice/v3/projects/0f516b2816e044efb51f301dd55941a2/statistic?classification=bug
{ }
响应示例
状态码:200
统计成功响应
{
"status" : "success",
"message" : null,
"result" : [ {
"category" : "RR",
"total" : 0,
"processing" : 0,
"completed" : 0,
"expired" : 0,
"category_name" : "原始需求"
}, {
"category" : "SF",
"total" : 2,
"processing" : 1,
"completed" : 0,
"expired" : 0,
"category_name" : "系统特性"
}, {
"category" : "IR",
"total" : 2,
"processing" : 1,
"completed" : 0,
"expired" : 1,
"category_name" : "初始需求"
}, {
"category" : "SR",
"total" : 1,
"processing" : 0,
"completed" : 0,
"expired" : 0,
"category_name" : "系统需求"
}, {
"category" : "AR",
"total" : 1,
"processing" : 0,
"completed" : 0,
"expired" : 0,
"category_name" : "分配需求"
}, {
"category" : "Task",
"total" : 1,
"processing" : 0,
"completed" : 0,
"expired" : 0,
"category_name" : "任务"
}, {
"category" : "Bug",
"total" : 5,
"processing" : 0,
"completed" : 0,
"expired" : 0,
"category_name" : "缺陷"
} ]
}
状态码:400
统计失败响应
{
"error_code" : "PM.02175302",
"error_msg" : "服务繁忙:ISSUE_SERVICE"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
统计成功响应 |
|
400 |
统计失败响应 |
错误码
请参见错误码。