文档首页/ 需求管理 CodeArts Req/ API参考/ API/ IPD统计概览/ 获取统计面板数据 - ShowIpdStatisticDashboard
更新时间:2026-09-01 GMT+08:00
分享

获取统计面板数据 - ShowIpdStatisticDashboard

功能介绍

获取需求/缺陷统计面板数据,数据会有5~10分钟延迟。

调用方法

请参见如何调用API。

授权信息

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

URI

POST /v1/ipdprojectservice/projects/{project_id}/statistic/dashboard

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目32位ID,项目唯一标识。通过查询IPD项目列表获取,响应消息体中的id字段的值就是项目ID。

约束限制:

不涉及。

取值范围:

32个字符,由英文字母和数字组成。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

classification

是

String

参数解释:

标识统计类型。

约束限制:

不涉及。

取值范围:

  • requirement:查询需求统计;

  • bug:查询缺陷统计。

默认取值:

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

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

约束限制:

不涉及。

取值范围:

10~32768个字符。

默认取值:

不涉及。

表4 请求Body参数

参数

是否必选

参数类型

描述

plan

否

PlanFilter object

参数解释:

发布计划过滤条件。

约束限制:

不涉及。

created_date

否

DateFilter object

参数解释:

工作项创建时间过滤条件。

约束限制:

不涉及。

表5 PlanFilter

参数

是否必选

参数类型

描述

plan_pi

否

String

参数解释:

按发布计划统计时,被统计的发布计划的ID。通过发布/迭代计划列表查询接口查询计划列表,返回参数中PlanVO里面的id字段即发布计划的ID。

约束限制:

18~19个字符的数字字符串。

取值范围:

不涉及。

默认取值:

不涉及。

plan_iteration

否

String

参数解释:

按发布计划下迭代计划统计时,迭代计划的ID。

约束限制:

18~19个字符的数字字符串。

取值范围:

不涉及。

默认取值:

不涉及。

表6 DateFilter

参数

是否必选

参数类型

描述

start_date

否

String

参数解释:

工作项创建时间不早于此时间,日期d的0点时间戳。

约束限制:

13~19个字符的数字字符串。

取值范围:

不涉及。

默认取值:

不涉及。

end_date

否

String

参数解释:

工作项创建时间不晚于此时间,日期d+1的0点时间戳。

约束限制:

13~19个字符的数字字符串。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码:200

表7 响应Body参数

参数

参数类型

描述

result

Array of DashboardSimpleVO objects

参数解释:

统计结果。

status

String

参数解释:

返回状态。

取值范围:

success:响应成功。

error:响应失败

message

String

参数解释:

请求失败信息。

取值范围:

不涉及。

表8 DashboardSimpleVO

参数

参数类型

描述

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

参数解释:

已完成的工作项数量。

取值范围:

不涉及。

uncompleted

Integer

参数解释:

未完成的工作项数量。

取值范围:

不涉及。

expired

Integer

参数解释:

已超期的工作项数量。

取值范围:

不涉及。

remain_di

Double

参数解释:

缺陷的遗留DI,统计范围为该项目下所有非关闭态、非草稿态的缺陷。

取值范围:

DI计算规则: DI=提示0.1 + 一般1 +严重3 + 致命10。

category_name

String

参数解释:

统计面板名称。

取值范围:

不涉及。

状态码:400

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

不涉及。

error_msg

String

参数解释:

错误描述,对error_code的补充解释。

取值范围:

不涉及。

请求示例

统计项目ID为a75f1c34cbf24e5fbbbc154dd823cd8e的缺陷。

POST https://{endpoint}/v1/ipdprojectservice/projects/a75f1c34cbf24e5fbbbc154dd823cd8e/statistic/dashboard?classification=bug

{ }

响应示例

状态码:200

统计成功响应

{
  "status" : "success",
  "message" : "",
  "result" : [ {
    "category" : "Bug",
    "total" : 2,
    "processing" : 1,
    "completed" : 0,
    "uncompleted" : 2,
    "expired" : 0,
    "remain_di" : 0.2,
    "category_name" : "缺陷概览统计"
  } ]
}

状态码:400

统计失败响应

{
  "error_code" : "PM.02175302",
  "error_msg" : "服务繁忙:ISSUE_SERVICE"
}

状态码

状态码

描述

200

统计成功响应

400

统计失败响应

错误码

请参见错误码。

相关文档