查询项目下缺陷(看板) - ShowDefectList
功能介绍
此接口用于在测试质量看板下查询项目下的缺陷情况统计
调用方法
请参见如何调用API。
URI
GET /v4/projects/{project_id}/defects
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目UUID,项目唯一标识,固定长度32位字符(字母和数字)。获取方式请参见获取项目ID |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| page_no | 否 | Integer | 页码 |
| page_size | 否 | Integer | 每页数量 |
| key_word | 否 | String | 关键字 |
| module_id | 否 | String | 模块id |
| iteration_ids | 否 | String | 迭代 |
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 参数解释: 调用此接口的响应状态。 取值范围:
|
| result | ResultValueListTestIssueVo object | 请求的返回的数据对象 |
| error | ApiError object | 错误信息。 |
| request_id | String | 由接口调用方传入,建议使用UUID保证请求的唯一性。 |
| server_address | String | 本次请求的受理的服务地址 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total | Integer | 起始记录数 大于 实际总条数时, 值为0, 分页请求才有此值 |
| value | Array of TestIssueVo objects | 实际的数据类型:单个对象,集合 或 NULL |
| reason | String | 业务失败的提示内容 |
| page_size | Integer | 分页大小 |
| page_no | Integer | 分页编码 |
| has_more | Boolean | 是否有更多 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| author | AuthorVo object | 作者信息 |
| domain | NameAndIdVo object | 租户信息 |
| module | NamePathAndPathVo object | 模块信息 |
| tracker | NameAndIdVo object | 事件信息 |
| status | NameAndIdVo object | 状态信息 |
| priority | NameAndIdVo object | 优先级 |
| severity | NameAndIdVo object | 严重程度 |
| project | ProjectVo object | 项目信息 |
| id | String | id |
| subject | String | 标题 |
| token | String | token |
| board | NameAndIdVo object | 看板 |
| relation | String | 需求层级关系 |
| assigned_to | AssignedVo object | 负责人 |
| sequence | String | xBoard项目工作项序列号 |
| sequence_id | String | xBoard项目工作项序列号 |
| created_on | String | 创建时间 |
| start_date | String | 创建日期 |
| fixed_version | NameAndIdVo object | 版本号 |
| plan_pi | NameAndIdVo object | pi信息 层级关系:pi -> 迭代 -> 需求 |
| assign_status | String | 参数解释: 分配状态。 取值范围:
|
| design_owner_id | String | 设计责任人id |
| design_owner | String | 设计责任人名称 |
| case_success_num | Integer | 用例成功个数 |
| case_failure_num | Integer | 用例失败个数 |
| case_disabled_num | Integer | 用例不可用个数 |
| case_wait_verification_num | Integer | 用例待核查个数 |
| case_blocking_num | Integer | 用例阻塞个数 |
| case_wait_execute_num | Integer | 待执行的用例个数 |
| case_total_num | Integer | 用例总数 |
| domain_name | String | 租户名 |
| domain_id | String | 租户id |
| new_create_num | Integer | 新建数量 |
| designing_num | Integer | 设计中数量 |
| testing_num | Integer | 测试中数量 |
| finished_num | Integer | 已完成数量 |
| issue_dynamic_count | Integer | 需求动态数量 |
| defect_num | Integer | 需求对应缺陷个数 |
| find_release_dev | String | 发现版本号 |
| case_status_map | Map<String,Integer> | 用例状态map |
| parent_issue_id | String | 父需求id |
| root_id | String | 根id |
| due_date | String | 结束数据 |
| is_parent | Boolean | 是否父级 |
| have_child_dynamic | Boolean | 父工作项下是否有子工作项包含动态 |
| tracker_id | String | 事件id |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| name | String | 名称 |
| id | String | id |
| identifier | String | id信息 |
| first_name | String | 名 |
| last_name | String | 姓 |
| author_nick_name | String | 作者昵称 |
| author_remark_name | String | 作者标识名 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | ID |
| name | String | 名称 |
| path | String | 路径id |
| path_name | String | 模块路径名称 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| id | String | ID |
| name | String | 名称 |
| identifier | String | id信息 |
| type | String | 参数解释: 类型 取值范围:
|
| 参数 | 参数类型 | 描述 |
|---|---|---|
| name | String | 名称 |
| id | String | id |
| identifier | String | id信息 |
| first_name | String | 名 |
| last_name | String | 姓 |
| assigned_nick_name | String | 责任人昵称 |
| assigned_remark_name | String | 责任人标记 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 接口调用失败错误码 |
| error_msg | String | 接口调用失败错误信息 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 接口调用失败错误码 |
| error_msg | String | 接口调用失败错误信息 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 接口调用失败错误码 |
| error_msg | String | 接口调用失败错误信息 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 接口调用失败错误码 |
| error_msg | String | 接口调用失败错误信息 |
请求示例
post https://{endpoint}/v4/projects/2e8b14eb90d54b6c9bc4c0b5cde1f449/defects?page_no=&page_size=&key_word=&module_id=&iteration_ids= 响应示例
状态码:200
OK
{
"value" : [ {
"case_failure_num" : 0,
"case_disabled_num" : 0,
"case_wait_verification_num" : 0,
"case_blocking_num" : 0,
"case_wait_execute_num" : 0,
"case_total_num" : 0,
"domain_name" : "string",
"domain_id" : "string",
"new_create_num" : 0,
"designing_num" : 0,
"testing_num" : 0,
"finished_num" : 0,
"issue_dynamic_count" : 0,
"defect_num" : 0,
"find_release_dev" : "string",
"case_status_map" : {
"additionalProp1" : 1,
"additionalProp2" : 2,
"additionalProp3" : 3
},
"is_parent" : true
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized |
| 404 | Not Found |
| 500 | Internal Server Error |
错误码
请参见错误码。