- 最新动态
- 功能总览
- 产品介绍
- 计费说明
- 快速入门
-
用户指南
- 需求管理(CodeArts Req)使用流程
- 购买并授权使用CodeArts Req
- 访问CodeArts Req服务首页
- 管理项目群
- 创建CodeArts项目
- 管理Scrum类型项目需求
- 管理IPD系统设备类型项目需求
- 管理IPD独立软件类型项目需求
- 管理IPD自运营/云服务类型项目需求
- 管理看板类型项目需求
- 查看审计日志（可选）
- 知识库用户指南
- 最佳实践
-
API参考
- 使用前必读
- API概览
- 如何调用API
-
API
- 用户信息
- 字段管理
- 项目成员
- 项目信息
- 项目指标
- 项目统计
- Scrum项目的迭代
-
Scrum项目的工作项
- 创建工作项类型自定义字段
- 上传图片
- 获取工作项完成率
- 获取指定工作项的评论列表
- 工时类型列表V5
- 按用户查询工时（单项目）
- 按用户查询工时（多项目）
- 查询用户详细工时
- 查询工作项工时记录V3
- 添加指定工作项工时
- 查询项目下的工时类型
- 获取工作项历史记录
- 创建工作项
- 创建工作项同时支持上传附件
- 查询项目的工作项
- 高级查询工作项
- 批量删除工作项V4
- 批量编辑工作项V2
- 查询工作项详情
- 更新工作项
- 删除工作项
- 删除工作项V4
- 获取子工作项
- 查询子工作项列表V2
- 获取工作项的评论V2
- 查询项目下所有工作项的历史记录
- 查询Scrum项目的工作项流转配置
- 细粒度权限用户创建工作项
- 查询当前工作项已经关联的工作项
- 查询当前工作项已经关联的关联Wiki
- 查询关联新版wiki信息V5
- 查询当前工作项已经关联的代码提交记录 / 分支创建记录
- 查询关联用例
- 查询Scrum工作项自定义字段
- 下载图片
- 上传工作项附件
- 下载工作项附件
- 删除附件
- 查询迭代下工作项状态的统计数据（处理人维度）
- 获取指定工作项停留时间
- 高级查询我的待办工作项
- 批量更新工作项
- 查询所有的严重程度
- 导出工作项V2
- 获取历史操作记录V2
- 查询关联工作项V2
- 查询工作项的所有标签
- 查询事务详情V2
- 工作项添加评论
- 工作项添加关注
- 查询自定义字段值
- 列表展示
- 查询卡片模式缓存
- 详情页的关于工作项的各项指标个数
- 树形模式下使用过滤条件查询工作项总数V4
- 在树形模式查询中，有过滤条件下的查询工作项列表接口
- 查询工作项的关联代码
- 工作项状态流转
- 快速新建子工作项
- 更新工作项
- 查询自己创建的和分享给自己的过滤器列表
- 查询迭代工作项
- 查询迭代详情
- 获取用户服务支持的特性
- 查询工作项中已离项的用户信息
- 更新模块信息
- 工作项描述中添加图片
- 复制工作项
- 根据条件过滤事物(临时过滤器看板)
- 上传工作项附件
- 配置流转处理人默认值可选范围
- 工作项上传图片
- 工作台我的待办高级搜索
- 修改工作项状态时联动修改对应状态的责任人
- 查询工作项及其所有父工作项
- 更新工作项评论
- 删除自定义项目模板
- 修改自定义项目模板名称和描述
- Scrum项目的模块
- Scrum项目的领域
- Scrum项目的设置
- Scrum项目成员
- Scrum项目的规划
- Scrum项目的状态
- Scrum项目的工作项工时操作记录管理
- 看板项目的工作项
- IPD项目计划管理
- IPD工作项管理
- IPD统计概览
- IPD模块管理
- IPD配置管理
- IPD评审单管理
- IPD标签管理
- IPD附件管理
- OpenAPI管理
- IPD字段管理
- IPD工作流
- IPD工作项流程
- 需求池
- 应用示例
- 附录
- 文档修订记录
- 场景代码示例
- 常见问题
- 视频帮助
- 文档下载
- 通用参考
链接复制成功！
获取统计面板数据
功能介绍
获取需求/缺陷统计面板数据，数据会有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 |
统计失败响应 |
错误码
请参见错误码。
