更新时间:2024-09-12 GMT+08:00
分享

新增自定义过滤器

功能介绍

新增自定义过滤器

URI

POST /GT3KServer/v4/projects/{project_uuid}/filters

表1 路径参数

参数

是否必选

参数类型

描述

project_uuid

String

项目ID

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

name

String

自定义过滤器名称

service_type

Integer

服务类型

stage_type

Integer

阶段过程(2:测试设计,3:测试执行,4:质量报告)

filter_content_info

FilterContentInfo object

自定义过滤器内容

表3 FilterContentInfo

参数

是否必选

参数类型

描述

status

Array of strings

状态

ranks

Array of strings

级别

results

Array of strings

结果

executors

Array of strings

执行者

owner_ids

Array of strings

处理者ID

module_ids

Array of strings

归属模块

issue_id

String

需求编号

creator_ids

Array of strings

创建者

release_ids

Array of strings

归属迭代

start_time

String

创建开始时间

end_time

String

创建结束时间

is_dissociation_case

String

是否关联需求

label_name_list

Array of strings

标签

execute_start_time

String

执行开始时间

execute_end_time

String

执行结束时间

is_keyword

Array of strings

关键字

test_types

Array of strings

类型

custom_field_filter

Map<String,Array<String>>

自定义字段过滤

review_status

Array of strings

用例评审状态

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

status

String

success|error

result

ResultValueCustomizedFilterVo object

请求的返回的数据对象

error

ApiError object

失败时的error信息

request_id

String

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

server_address

String

本次请求的受理的服务地址。

表5 ResultValueCustomizedFilterVo

参数

参数类型

描述

total

Integer

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

value

CustomizedFilterVo object

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

reason

String

业务失败的提示内容

page_size

Integer

每页展示条数

page_no

Integer

页码

has_more

Boolean

是否有更多

表6 CustomizedFilterVo

参数

参数类型

描述

uri

String

自定义过滤器URI

name

String

自定义过滤器名称

filter

String

过滤器内容

type

Integer

过滤器类型(1:设计页功能用例,2:设计页接口用例 ,3:执行页功能用例 ,4:执行页接口用例)

updator

String

更新人

region

String

逻辑Region

service_type

Integer

服务类型

stage_type

Integer

阶段过程(2:测试设计,3:测试执行,4:质量报告)

user_id

String

用户ID

creator

String

创建人

create_time

String

创建时间

create_time_timestamp

Long

创建时间时间戳

update_time

String

更新时间

update_time_timestamp

Long

更新时间时间戳

project_id

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/projects/3d2378e0fc504c638f48b21377d6add1/filters

{
  "filter_content_info" : {
    "results" : [ -2 ]
  },
  "name" : "未执行用例",
  "project_uuid" : "84b218bb1b504019bbeb64b8dc745a94",
  "service_type" : -1,
  "stage_type" : "2"
}

响应示例

状态码: 200

OK

{
  "status" : "success",
  "result" : {
    "value" : {
      "uri" : "v91k0000vrroldin",
      "name" : "自定义1",
      "filter" : "{\"moduleIds\":[\"undefined\"]}",
      "updator" : "efdb403066474ab08836b9eeaaa23bca",
      "region" : "cn-north-7",
      "service_type" : -1,
      "stage_type" : 2,
      "user_id" : "efdb403066474ab08836b9eeaaa23bca",
      "creator" : "efdb403066474ab08836b9eeaaa23bca",
      "project_uuid" : "3d2378e0fc504c638f48b21377d6add1"
    }
  }
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码

相关文档