获取项目概览
功能介绍
获取项目概览
调用方法
请参见如何调用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 |
错误码
请参见错误码。
