更新时间:2022-12-08 GMT+08:00

获取项目概览

功能介绍

获取项目概览

URI

GET /v4/projects/{project_id}/summary

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

devcloud项目的32位id

最小长度:32

最大长度:32

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

最小长度:10

最大长度:32768

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

bug_statistics

Array of BugStatisticResponseV4 objects

bug统计列表

demand_statistics

Array of DemandStatisticResponseV4 objects

按模块统计列表

issue_completion_rates

Array of IssueCompletionRateResponseV4 objects

按工作项类型统计列表

project_id

String

项目id

表4 BugStatisticResponseV4

参数

参数类型

描述

critical_num

Integer

重要程度为关键的缺陷数

defect_index

Double

DI

module

String

模块

normal_num

Integer

重要程度为一般的缺陷数

serious_num

Integer

重要程度为严重的缺陷数

tip_num

Integer

重要程度为提示的缺陷数

total

Integer

总数

表5 DemandStatisticResponseV4

参数

参数类型

描述

closed_num

Integer

已关闭数量

module

String

模块

new_num

Integer

新建的数量

process_num

Integer

开发中的数量

rejected_num

Integer

已拒绝数量

solved_num

Integer

已解决数量

test_num

Integer

测试中的数量

total

Integer

总数

表6 IssueCompletionRateResponseV4

参数

参数类型

描述

issue_status

IssueStatusResponseV4 object

工作项的统计信息

tracker_id

Integer

工作项类型,2任务/Task,3缺陷/Bug,5Epic,6Feature,7Story

表7 IssueStatusResponseV4

参数

参数类型

描述

closed_num

Integer

已关闭数量

new_num

Integer

新建的数量

process_num

Integer

开发中的数量

rejected_num

Integer

已拒绝数量

solved_num

Integer

已解决数量

test_num

Integer

测试中的数量

状态码: 400

表8 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

状态码: 401

表9 响应Body参数

参数

参数类型

描述

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

错误码

请参见错误码