更新时间:2025-07-25 GMT+08:00
分享

根据条件分页获取测试点对象

功能介绍

根据条件分页获取测试点对象

调用方法

请参见如何调用API

URI

POST /v2/{project_id}/testpoints/page

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目的32位uuid,项目唯一标识,通过获取CodeArts项目ID接口查询项目列表获取。

取值范围:

字符串长度32。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

必传。

取值范围:

字符串长度不少于1,不超过10万。

默认取值:

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

params

TestPointPageParam object

参数解释:

测试点分页参数

表4 TestPointPageParam

参数

是否必选

参数类型

描述

deleted

String

参数解释:

是否删除

取值范围:

  • 1,表示已删除

  • 0,表示未删除

limit

Integer

参数解释:

每页显示的条目数量,最大支持200条

offset

Integer

参数解释:

起始偏移量,表示从此偏移量开始查询,offset大于等于0,小于等于100000

mindmap_id

String

参数解释:

脑图ID

取值范围:

大小写字母、数字。

长度限制固定32位

node_id

String

参数解释:

节点ID

取值范围:

大小写字母、数字。

长度限制固定32位

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码

取值范围:

大小写字母、数字。

长度限制0到20位

data

BasePageInfoTestPoint object

参数解释:

返回体

取值范围:

不涉及

message

String

参数解释:

错误信息

取值范围:

大小写字母、数字、符号、中文。

长度限制0到1000位

表6 BasePageInfoTestPoint

参数

参数类型

描述

limit

Integer

参数解释:

每页显示的条目数量,最大支持200条

取值范围:

数字,范围1-200

list

Array of TestPoint objects

参数解释:

返回体

取值范围:

不涉及

offset

Integer

参数解释:

起始偏移量,表示从此偏移量开始查询,offset大于等于0,小于等于100000

取值范围:

数字,范围0-100000

pages

Integer

参数解释:

总页数量

取值范围:

数字,范围1-100

size

Integer

参数解释:

列表个数

取值范围:

数字,范围1-200

total

Long

参数解释:

总数

取值范围:

数字

表7 TestPoint

参数

参数类型

描述

app

String

参数解释:

app。

取值范围:

大小写字母、数字、符号、中文。

create_time

String

参数解释:

创建时间

取值范围:

固定日期格式yyyy-MM-dd HH:mm:ss

creator_name

String

参数解释:

创建人名称。

取值范围:

大小写字母、数字、符号、中文。

creator_num

String

参数解释:

创建者,用户在IAM中的ID。

取值范围:

大小写字母、数字。

长度限制固定32位

delete_time

String

参数解释:

删除时间

取值范围:

固定日期格式yyyy-MM-dd HH:mm:ss

deleted

String

参数解释:

逻辑删除字段

取值范围:

大小写字母、数字。

group_id

String

参数解释:

分组id

取值范围:

大小写字母、数字。

id

String

参数解释:

id 主键

取值范围:

大小写字母、数字。

mindmap_id

String

参数解释:

脑图ID

取值范围:

大小写字母、数字。

长度限制固定32位

name

String

参数解释:

名称

取值范围:

大小写字母、数字、符号、中文。

node_id

String

参数解释:

节点ID

取值范围:

大小写字母、数字。

长度限制固定32位

requirement_id

String

参数解释:

需求id

取值范围:

大小写字母、数字。

requirement_name

String

参数解释:

需求名称

取值范围:

大小写字母、数字、符号、中文。

service_id

String

参数解释:

服务id

取值范围:

大小写字母、数字。

status

String

参数解释:

状态

取值范围:

大小写字母、数字、符号、中文。

status_type

String

参数解释:

状体类型

取值范围:

大小写字母、数字、符号、中文。

tc_counts

String

参数解释:

tc数量

取值范围:

数字

test_cases

String

参数解释:

测试用例

取值范围:

大小写字母、数字、符号、中文。

update_name

String

参数解释:

更新人名称。

取值范围:

大小写字母、数字、符号、中文。

update_num

String

参数解释:

更新人工号

取值范围:

大小写字母、数字、符号。

update_time

String

参数解释:

更新时间

取值范围:

固定日期格式yyyy-MM-dd HH:mm:ss

version

String

参数解释:

版本

取值范围:

大小写字母、数字、符号、中文。

状态码:400

表8 响应Body参数

参数

参数类型

描述

code

String

参数解释:

接口调用错误码。

取值范围:

大小写字母、数字。

长度限制0到20位

data

String

参数解释:

接口调用返回体

取值范围:

不涉及

message

String

参数解释:

接口调用错误信息

取值范围:

大小写字母、数字、符号、中文。

长度限制0到1000位

状态码:401

表9 响应Body参数

参数

参数类型

描述

code

String

参数解释:

接口调用错误码。

取值范围:

大小写字母、数字。

长度限制0到20位

data

String

参数解释:

接口调用返回体

取值范围:

不涉及

message

String

参数解释:

接口调用错误信息

取值范围:

大小写字母、数字、符号、中文。

长度限制0到1000位

请求示例

根据条件分页获取测试点对象

post https://{endpoint}/v2/b94c9a6947a44597891e0a7362e7383f/testpoints/page

{
  "params" : {
    "mindmap_id" : "ba2725c5b72c4ec18214736ceb99f3d7",
    "offset" : 1,
    "limit" : 10
  }
}

响应示例

状态码:200

OK

{
  "code" : "success",
  "data" : {
    "total" : 1,
    "list" : [ {
      "id" : "0627DAC8F65C44A0A6CE44D43F79B29A",
      "name" : "子主题",
      "status" : null,
      "deleted" : "no",
      "app" : null,
      "version" : null,
      "create_time" : "2025/01/10 10:57:53 GMT+08:00",
      "creator_name" : "昵称xxx1111144445454545",
      "creator_num" : "efdb403066474ab08836b9eeaaa23bca",
      "update_name" : "昵称xxx1111144445454545",
      "update_num" : "efdb403066474ab08836b9eeaaa23bca",
      "update_time" : "2025/01/10 10:57:53 GMT+08:00",
      "mindmap_id" : "fb6bd82a6c084fdab0d8e5d8f820eabc",
      "node_id" : "7B3E87D771504220A2B9C757E6AC42E1",
      "test_cases" : null,
      "tc_counts" : null,
      "status_type" : null,
      "requirement_id" : null,
      "requirement_name" : null,
      "group_id" : null,
      "service_id" : null,
      "delete_time" : null
    } ],
    "offset" : 1,
    "limit" : 10,
    "pages" : 1,
    "size" : 1
  },
  "message" : null
}

状态码:400

Bad Request

{
  "error_code" : "TESTMIND.00021882",
  "error_msg" : "分支、计划id长度不合法,请稍后重试"
}

状态码:401

Unauthorized

{
  "error_code" : "DEV.00000003",
  "error_msg" : "认证信息过期"
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

错误码

请参见错误码

相关文档