文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 自定义测试服务用例管理/ 查询迭代下的缺陷信息
更新时间：2024-11-19 GMT+08:00
查看PDF
分享

查询迭代下的缺陷信息

功能介绍

查询迭代下的缺陷信息

URI

POST /v4/{project_id}/iterators/{iterator_uri}/defects/batch-query

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目id，对应"需求管理 CodeArts Req"项目唯一标识，测试计划管理页面地址栏url https://{host}/cloudtestportal/project/{project_id}/testplan中project_id变量的值

约束限制:

不涉及

取值范围:

项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字

默认取值:

不涉及

iterator_uri

是

String

迭代uri

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

key_word

否

String

关键字

page_size

是

Integer

每页数量

page_no

是

Integer

页码

sort_field

否

String

排序字段

sort_type

否

String

排序类型

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

status

String

success|error;

result

ResultValueListWorkItemVo object

请求的返回的数据对象

error

ApiError object

失败时的error信息

request_id

String

由接口调用方传入，建议使用UUID保证请求的唯一性。

server_address

String

本次请求的受理的服务地址
表5 ResultValueListWorkItemVo

参数

参数类型

描述

value

Array of WorkItemVo objects

实际的数据类型：单个对象，集合 或 NULL
表6 WorkItemVo

参数

参数类型

描述

name

String

工作项名称

owner

String

处理人

path

String

工作项路径

start_date

String

预计开始日期

due_date

String

预计结束日期

region

String

逻辑region，外部使用公有云实际区域，内部使用默认值

creator

String

创建人

updator

String

更新人

project_uuid

String

项目ID，外部使用项目ID，内部使用默认值

work_item_id

String

工作项编号

status_id

String

状态ID

status_name

String

状态

tracker_id

String

类型ID

tracker_name

String

类型

iteration_id

String

迭代ID

module_id

String

模块ID

severity_id

String

重要程度ID

severity_name

String

重要程度

parent_workitem_id

String

父工作项编号

board_id

String

看板ID

board_name

String

看板

create_time

String

创建时间

update_time

String

更新时间

iteration_name

String

迭代名

module_name

String

模块名

module_path

String

模块path

module_path_name

String

模块路径名称

owner_name

String

处理人

have_child_dynamic

Boolean

父工作项下是否有子工作项包含动态

has_child

Boolean

父工作项下是否有子工作项

issue_dynamic_count

Integer

需求动态数量

case_count

Integer

用例数量

sequence_id

String

xBoard项目工作项序列号

pi_id

String

pi的id，层级关系：pi -> 迭代 -> 需求

pi_name

String

迭代ID
表7 ApiError

参数

参数类型

描述

code

String

业务失败的错误码

reason

String

业务失败的提示内容

状态码： 400

表8 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码： 401

表9 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码： 404

表10 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

状态码： 500

表11 响应Body参数

参数

参数类型

描述

error_code

String

接口调用失败错误码

error_msg

String

接口调用失败错误信息

请求示例

查询迭代下的缺陷信息

post https://{endpoint}/v4/300c6295a54c4c698608c878f47ddd59/iterators/v91j0000vldleodb/defects/batch-query

{
  "project_uuid" : "300c6295a54c4c698608c878f47ddd59",
  "iterator_uri" : "v91j0000vldleodb",
  "page_no" : 1,
  "page_size" : 6,
  "key_word" : "",
  "sort_field" : "",
  "sort_type" : ""
}

响应示例

状态码： 200

OK

{
  "status" : "success",
  "result" : {
    "total" : 1,
    "value" : [ {
      "name" : "新增的缺陷",
      "owner" : "xxx",
      "path" : "8452839",
      "region" : "cn-north-7",
      "creator" : "xxx",
      "project_uuid" : "300c6295a54c4c698608c878f47ddd59",
      "work_item_id" : "8452839",
      "status_id" : "1",
      "status_name" : "新建",
      "tracker_id" : "3",
      "tracker_name" : "缺陷",
      "severity_id" : "12",
      "severity_name" : "一般",
      "create_time" : "2024-09-11 11:05:27",
      "update_time" : "2024-09-11 11:05:27",
      "have_child_dynamic" : false,
      "has_child" : false,
      "issue_dynamic_count" : 0,
      "case_count" : 0,
      "sequence_id" : ""
    } ],
    "page_size" : 6,
    "page_no" : 1
  }
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

相关文档