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

查询需求按时完成率

功能介绍

查询需求按时完成率

URI

POST /v1/{project_id}/completion-rate/query

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

devcloud项目的32位id

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

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

表3 请求Body参数

参数

是否必选

参数类型

描述

date_range

String

统计周期

metric_type

String

指标类型

sprint_id

String

迭代ID

dividend

dividend object

指标分子过滤条件

divisor

Object

指标分母过滤条件

表4 dividend

参数

是否必选

参数类型

描述

on_time

String

是否按时

custom_field16

String

自定义字段

custom_field17

String

自定义字段

custom_field18

String

自定义字段

custom_field19

String

自定义字段

custom_field20

String

自定义字段

custom_field21

String

自定义字段

custom_field22

String

自定义字段

custom_field23

String

自定义字段

custom_field24

String

自定义字段

custom_field25

String

自定义字段

custom_field26

String

自定义字段

custom_field27

String

自定义字段

custom_field28

String

自定义字段

custom_field29

String

自定义字段

custom_field30

String

自定义字段

custom_field31

String

自定义字段

custom_field32

String

自定义字段

custom_field33

String

自定义字段

custom_field34

String

自定义字段

custom_field35

String

自定义字段

custom_field36

String

自定义字段

custom_field37

String

自定义字段

custom_field38

String

自定义字段

custom_field39

String

自定义字段

custom_field40

String

自定义字段

响应参数

状态码: 200

表5 响应Body参数

参数

参数类型

描述

dividend_value

String

指标分子数值

divisor_value

String

指标分母数值

metric_name

String

指标名称

metric_value

String

指标数值

project_id

String

项目ID

project_name

String

项目名称

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

状态码: 401

表7 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

请求示例

Post https://{endpoint}/v1/eace9c0a00574de6878ab580daa9a317/completion-rate/query

{
  "date_range" : "1598457600000,1598544000000",
  "dividend" : {
    "custom_field16" : "自定义字段值",
    "on_time" : "ontime"
  },
  "divisor" : { },
  "metric_type" : "on-time_completion_rate",
  "sprint_id" : "8883443"
}

响应示例

状态码: 200

OK

{
  "dividend_value" : 15,
  "divisor_value" : 20,
  "metric_name" : "completion_rate|bug_density|bugs_per_developer",
  "metric_value" : 0.8945,
  "project_id" : "eace9c0a00574de6878ab580daa9a317",
  "project_name" : "我的项目"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

错误码

请参见错误码