更新时间:2025-06-26 GMT+08:00
分享

搜索用例评审记录

功能介绍

搜索用例评审记录

调用方法

请参见如何调用API

URI

POST /v4/testcases/review/search

请求参数

表1 请求Body参数

参数

是否必选

参数类型

描述

reviewer

String

评审人

comment

String

评审意见

status

String

闭环状态

project_id

String

项目UUID,项目唯一标识,固定长度32位字符(字母和数字)。获取方式请参见获取项目ID

version_uri

String

版本URI

feature_uri

String

特性目录URI

testcase_number

String

用例编号

testcase_name

String

用例名

close_user_id

String

指定闭环人

actual_close_person

String

实际闭环人

close_comment

String

闭环意见

review_start_date

String

评审开始时间

review_end_date

String

评审结束时间

close_start_date

String

闭环开始时间

close_end_date

String

闭环结束时间

page_no

Integer

当前页数

page_size

Integer

每页条数

sort_field

String

排序字段

sort_type

String

排序方式

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

status

String

参数解释

本次请求的处理状态

取值范围

success|error

result

ResultValueListTestCaseReviewVo object

参数解释

测试用例评审信息

取值范围

不涉及

error

ApiError object

参数解释

错误信息

取值范围

不涉及

表3 ResultValueListTestCaseReviewVo

参数

参数类型

描述

total

Integer

参数解释

符合条件的所有记录数

取值范围

起始记录数 大于 实际总条数时, 值为0, 分页请求才有此值

value

Array of TestCaseReviewVo objects

参数解释

本次查询的记录结果

取值范围

实际的数据类型:单个对象,集合 或 NULL

reason

String

参数解释

业务失败的提示内容

取值范围

不涉及

page_size

Integer

参数解释

每页展示条数

取值范围

不涉及

page_no

Integer

参数解释

页码

取值范围

不涉及

has_more

Boolean

参数解释

是否有更多

取值范围

true:是 false:否

表4 TestCaseReviewVo

参数

参数类型

描述

uri

String

参数解释

评审URI

取值范围

不涉及

testcase_name

String

参数解释

用例名称

取值范围

不涉及

testcase_number

String

参数解释

用例编号

取值范围

不涉及

testcase_stage

String

参数解释

用例阶段

取值范围

不涉及

testcase_last_modified

String

参数解释

用例修改时间

取值范围

不涉及

testcase_last_modified_timestamp

Long

参数解释

用例修改时间时间戳

取值范围

不涉及

testcase_uri

String

参数解释

分支用例URI

取值范围

不涉及

version_uri

String

参数解释

版本URI

取值范围

不涉及

version_name

String

参数解释

版本名称

取值范围

不涉及

comment

String

参数解释

评审意见

取值范围

不涉及

close_comment

String

参数解释

闭环意见

取值范围

不涉及

reviewer

String

参数解释

评审人

取值范围

不涉及

creation_date

String

参数解释

评审创建时间

取值范围

不涉及

creation_date_timestamp

Long

参数解释

评审创建时间时间戳

取值范围

不涉及

close_user_ids

Array of NameAndIdVo objects

参数解释

指定的闭环人列表

取值范围

不涉及

actual_close_person

String

参数解释

实际闭环人

取值范围

不涉及

status

String

参数解释

评审状态

取值范围

不涉及

close_date

String

参数解释

评审闭环时间

取值范围

不涉及

close_date_timestamp

Long

参数解释

评审闭环时间时间戳

取值范围

不涉及

expect_close_date

String

参数解释

期望闭环时间

取值范围

不涉及

expect_close_date_timestamp

Long

参数解释

期望闭环时间时间戳

取值范围

不涉及

表5 NameAndIdVo

参数

参数类型

描述

id

String

参数解释

ID

取值范围

不涉及

name

String

参数解释

名称

取值范围

不涉及

表6 ApiError

参数

参数类型

描述

code

String

参数解释:

业务失败的错误码

取值范围:

不涉及

reason

String

参数解释:

业务失败的提示内容

取值范围:

不涉及

状态码:400

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码:401

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码:404

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

状态码:500

表10 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

接口调用失败错误码

取值范围:

不涉及

error_msg

String

参数解释:

接口调用失败错误信息

取值范围:

不涉及

请求示例

post https://{endpoint}/v4/testcases/review/search

{
  "reviewer" : "1001",
  "comment" : "评审",
  "status" : "1",
  "project_id" : "bc472858dbe54bb5ac0a473cad0eed12",
  "version_uri" : "63dasd3baf",
  "feature_uri" : "63dasd3baf",
  "testcase_number" : "1001",
  "testcase_name" : "1001",
  "close_user_id" : "1001",
  "actual_close_person" : "1001",
  "close_comment" : "评审",
  "review_start_date" : "2022-10-31 00:00:00",
  "review_end_date" : "2022-10-31 00:00:00",
  "close_start_date" : "2022-10-31 00:00:00",
  "close_end_date" : "2022-10-31 00:00:00",
  "page_no" : 1,
  "page_size" : 10,
  "sort_field" : "testCaseNumber",
  "sort_type" : "ASC"
}

响应示例

状态码:200

OK

{
  "status" : "success",
  "result" : {
    "total" : 1,
    "value" : [ {
      "uri" : "63dasd3bad",
      "testcase_name" : "用例1",
      "testcase_number" : "用例1",
      "testcase_stage" : "1",
      "testcase_last_modified" : "2022-11-01 00:00:00",
      "testcase_last_modified_timestamp" : 1660617231016,
      "testcase_uri" : "63dasd3baf",
      "version_uri" : "63dasd3baf",
      "version_name" : "BaseLine",
      "comment" : "建议修改用例名称",
      "close_comment" : "通过",
      "reviewer" : "z000001",
      "creation_date" : "2022-10-31 00:00:00",
      "creation_date_timestamp" : 1660617231016,
      "close_user_ids" : [ "z000001", "z000002" ],
      "actual_close_person" : "z000001",
      "status" : "1",
      "close_date" : "2022-10-31 00:00:00",
      "close_date_timestamp" : 1660617231016,
      "expect_close_date" : "2022-10-31",
      "expect_close_date_timestamp" : 1660617231016
    } ],
    "reason" : "string",
    "page_size" : 0,
    "page_no" : 0,
    "has_more" : true
  },
  "error" : { }
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码

相关文档