- 最新动态
- 功能总览
- 产品介绍
- 计费说明
- 快速入门
-
用户指南
- 需求管理(CodeArts Req)使用流程
- 购买并授权使用CodeArts Req
- 访问CodeArts Req服务首页
- 创建CodeArts项目
- 管理Scrum类型项目需求
- 管理IPD系统设备类型项目需求
- 管理IPD独立软件类型项目需求
- 管理IPD自运营/云服务类型项目需求
- 管理看板类型项目需求
- 查看审计日志(可选)
- 知识库用户指南
- 最佳实践
-
API参考
- 使用前必读
- API概览
- 如何调用API
-
API
- 用户信息
- 项目成员
- 项目信息
- 项目指标
- 项目统计
- 项目及成员
- Scrum项目的迭代
-
Scrum项目的工作项
- 创建工作项类型自定义字段
- 上传图片
- 获取工作项完成率
- 获取指定工作项的评论列表
- 按用户查询工时(单项目)
- 按用户查询工时(多项目)
- 添加指定工作项工时
- 查询项目下的工时类型
- 获取工作项历史记录
- 创建工作项
- 查询项目的工作项
- 高级查询工作项
- 批量删除工作项
- 查询工作项详情
- 更新工作项
- 删除工作项
- 获取子工作项
- 查询项目下所有工作项的历史记录
- 查询Scrum项目的工作项流转配置
- 细粒度权限用户创建工作项
- 查询当前工作项已经关联的工作项
- 查询当前工作项已经关联的关联Wiki
- 查询当前工作项已经关联的代码提交记录 / 分支创建记录
- 查询关联用例
- 查询Scrum工作项自定义字段
- 下载图片
- 上传工作项附件
- 下载工作项附件
- 删除附件
- 查询迭代下工作项状态的统计数据(处理人维度)
- 获取指定工作项停留时间
- 高级查询我的待办工作项
- Scrum项目的模块
- Scrum项目的领域
- Scrum项目的状态
- 看板项目的工作项
- IPD项目计划管理
- IPD工作项管理
- IPD统计概览
- IPD模块管理
- IPD配置管理
- IPD评审单管理
- IPD标签管理
- OpenAPI管理
- 应用示例
- 附录
- 文档修订记录
- 常见问题
- 视频帮助
- 文档下载
- 通用参考
链接复制成功!
获取项目概览
功能介绍
获取项目概览
调用方法
请参见如何调用API。
URI
GET /v4/projects/{project_id}/summary
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释:项目的32位uuid,项目唯一标识,可以通过ListProjectsV4接口查询项目列表 约束限制:正则表达式, ^[A-Za-z0-9]{32}$ 取值范围:字符串,最小长度:32,最大长度:32 默认取值:不涉及 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释:用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制:不涉及 取值范围:最小长度:10,最大长度:32768 默认取值:不涉及 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
bug_statistics |
Array of BugStatisticResponseV4 objects |
bug统计列表 |
demand_statistics |
Array of DemandStatisticResponseV4 objects |
按模块统计列表 |
issue_completion_rates |
Array of IssueCompletionRateResponseV4 objects |
按工作项类型统计列表 |
project_id |
String |
项目的32位id,项目唯一标识 |
参数 |
参数类型 |
描述 |
---|---|---|
critical_num |
Integer |
重要程度为关键的缺陷数,重要程度为关键对应id为10 |
defect_index |
Double |
DI值,不同重要程度的缺陷对应不同的分值 |
module |
String |
模块 |
normal_num |
Integer |
重要程度为一般的缺陷数,重要程度为一般对应id为12 |
serious_num |
Integer |
重要程度为严重的缺陷数,重要程度为严重对应id为11 |
tip_num |
Integer |
重要程度为提示的缺陷数,重要程度为提示对应id为13 |
total |
Integer |
当前项目下bug统计总数 |
参数 |
参数类型 |
描述 |
---|---|---|
closed_num |
Integer |
按模块统计已关闭数量 |
module |
String |
模块 |
new_num |
Integer |
按模块统计新建的数量 |
process_num |
Integer |
按模块统计开发中的数量 |
rejected_num |
Integer |
按模块统计已拒绝数量 |
solved_num |
Integer |
按模块统计已解决数量 |
test_num |
Integer |
按模块统计测试中的数量 |
total |
Integer |
按模块统计总数 |
参数 |
参数类型 |
描述 |
---|---|---|
issue_status |
IssueStatusResponseV4 object |
工作项状态维度的统计信息 |
tracker_id |
Integer |
工作项类型,2任务/Task,3缺陷/Bug,5Epic,6Feature,7Story |
参数 |
参数类型 |
描述 |
---|---|---|
closed_num |
Integer |
当前项目中工作项已关闭数量 |
new_num |
Integer |
当前项目中工作项新建的数量 |
process_num |
Integer |
当前项目中工作项开发中的数量 |
rejected_num |
Integer |
当前项目中工作项已拒绝数量 |
solved_num |
Integer |
当前项目中工作项已解决数量 |
test_num |
Integer |
当前项目中工作项测试中的数量 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误描述 |
error_code |
String |
错误码 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误描述 |
error_code |
String |
错误码 |
请求示例
GET https://{endpoint}/v4/projects/526cefde62004de2b62b5e8dd2c2b3af/summary GET https://{endpoint}/v4/projects/526cefde62004de2b62b5e8dd2c2b3af/summary
响应示例
状态码: 200
OK
{ "bug_statistics" : [ { "critical_num" : 0, "defect_index" : 1, "module" : "统计分数", "normal_num" : 1, "serious_num" : 0, "tip_num" : 0, "total" : 1 } ], "demand_statistics" : [ { "closed_num" : 1, "module" : "计费", "new_num" : 1, "process_num" : 1, "rejected_num" : 1, "solved_num" : 1, "test_num" : 1, "total" : 1 } ], "issue_completion_rates" : [ { "issue_status" : { "closed_num" : 1, "new_num" : 1, "process_num" : 1, "rejected_num" : 1, "solved_num" : 1, "test_num" : 1 }, "tracker_id" : 0 } ], "project_id" : "526cefde62004de2b62b5e8dd2c2b3af" }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
错误码
请参见错误码。