# 查询迭代下的缺陷信息 - ShowIteratorDefects #### 功能介绍 此接口用于查询迭代下的缺陷信息,同页面 项目协作 -\> 缺陷管理 -\> 右侧展示缺陷列表，上方任务栏筛选发现发布/发现迭代 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-testman/cloudtest_03_2000.html)。 #### URI POST /v4/{project_id}/iterators/{iterator_uri}/defects/batch-query 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**: 项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-testman/cloudtest_03_4003.html) **约束限制**: 字符串类型，长度32位字符 **取值范围**: 项目uuid应符合如下规则：长度等于32位，包含大小写字母、数字 **默认取值**: 不涉及 | | iterator_uri | 是 | String | 迭代uri | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。 通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 必传。 **取值范围：** 字符串长度不少于1，不超过10万。 **默认取值：** 不涉及。 | 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | key_word | 否 | String | 关键字 | | page_size | 是 | Integer | 每页数量 | | page_no | 是 | Integer | 页码 | | sort_field | 否 | String | 排序字段 | | sort_type | 否 | String | **参数解释**: 排序类型 **约束限制**: 不涉及 **取值范围**: - ASC，升序。 - DESC，降序。 **默认取值**: 不涉及 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | value | Array of [WorkItemVo] objects | 请求返回的数据 | | total | Integer | 数据总数 | | page_no | Integer | 页码 | | page_size | Integer | 每页数据行数 | 表5WorkItemVo | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释** 工作项名称 **取值范围** 不涉及 | | owner | String | **参数解释** 处理人 **取值范围** 不涉及 | | path | String | **参数解释** 工作项路径 **取值范围** 不涉及 | | start_date | String | **参数解释** 预计开始日期 **取值范围** 不涉及 | | due_date | String | **参数解释** 预计结束日期 **取值范围** 不涉及 | | region | String | **参数解释** 逻辑region **取值范围** 使用公有云实际区域 | | creator | String | **参数解释** 创建人 **取值范围** 不涉及 | | updator | String | **参数解释** 更新人 **取值范围** 不涉及 | | project_uuid | String | **参数解释** 项目UUID **取值范围** 项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-testman/cloudtest_03_4003.html) | | 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 | **参数解释** 父工作项下是否有子工作项包含动态 **取值范围** true:是 false:否 | | has_child | Boolean | **参数解释** 父工作项下是否有子工作项 **取值范围** true:有子工作项 false:无子工作项 | | issue_dynamic_count | Integer | **参数解释** 需求动态数量 **取值范围** 不涉及 | | case_count | Integer | **参数解释** 用例数量 **取值范围** 不涉及 | | sequence_id | String | **参数解释** xBoard项目工作项序列 **取值范围** 不涉及 | | pi_id | String | **参数解释** pi的id **取值范围** 层级关系：pi -\> 迭代 -\> 需求 | | pi_name | String | **参数解释** pi名称 **取值范围** 不涉及 | **状态码：400** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**: 接口调用失败错误码 **取值范围**: 不涉及 | | error_msg | String | **参数解释**: 接口调用失败错误信息 **取值范围**: 不涉及 | **状态码：401** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**: 接口调用失败错误码 **取值范围**: 不涉及 | | error_msg | String | **参数解释**: 接口调用失败错误信息 **取值范围**: 不涉及 | **状态码：404** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**: 接口调用失败错误码 **取值范围**: 不涉及 | | error_msg | String | **参数解释**: 接口调用失败错误信息 **取值范围**: 不涉及 | **状态码：500** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**: 接口调用失败错误码 **取值范围**: 不涉及 | | error_msg | String | **参数解释**: 接口调用失败错误信息 **取值范围**: 不涉及 | #### 请求示例 查询迭代下的缺陷信息 ``` post https://{endpoint}/v4/300c6295a54c4c698608c878f47ddd59/iterators/v91j0000vldleodb/defects/batch-query { "page_no" : 1, "page_size" : 6, "key_word" : "", "sort_field" : "", "sort_type" : "" } ``` #### 响应示例 **状态码：200** OK ``` { "total" : 20, "page_no" : 1, "page_size" : 6, "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" : "" } ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad Request | | 401 | Unauthorized | | 404 | Not Found | | 500 | Internal Server Error | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-testman/ErrorCode.html)。