文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 接口测试管理/ 分页获取工程关键字详细信息列表(含目录)
更新时间:2025-07-25 GMT+08:00
分享

分页获取工程关键字详细信息列表(含目录)

功能介绍

分页获取工程关键字列表(含目录)

调用方法

请参见如何调用API

URI

POST /v3/{project_id}/aw-cata/aw-info-list

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

不涉及

取值范围

32个字符组成的字符串

默认取值

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

必传。

取值范围:

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

默认取值:

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

aw_type

String

关键字类型1-普通关键字,2-组合关键字,3-导入关键字

cata_type

Integer

目录层级

current_project_id

String

工程唯一标识

is_positive_order

Boolean

是否按名称正序排序

page_no

Integer

当前页数

page_size

Integer

每页多少记录

parent_id

String

关键字目录父编号

search_type

String

过滤类型

search_value

String

过滤条件

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

error

CommonResponseErrorOfobject object

统一错误返回

reason

String

错误原因

result

Object

结果

status

String

状态值,如success、error

表5 CommonResponseErrorOfobject

参数

参数类型

描述

code

String

错误码

reason

String

错误原因

状态码:401

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

12-18个字符组成的字符串

error_msg

String

参数解释

接口调用失败错误信息

取值范围

3-1000个字符组成的字符串

状态码:403

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

12-18个字符组成的字符串

error_msg

String

参数解释

接口调用失败错误信息

取值范围

3-1000个字符组成的字符串

状态码:404

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

12-18个字符组成的字符串

error_msg

String

参数解释

接口调用失败错误信息

取值范围

3-1000个字符组成的字符串

状态码:500

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

12-18个字符组成的字符串

error_msg

String

参数解释

接口调用失败错误信息

取值范围

3-1000个字符组成的字符串

请求示例

{
  "search_value" : "",
  "current_project_id" : "",
  "is_positive_order" : false,
  "parent_id" : "TOP",
  "page_no" : 1,
  "aw_type" : "",
  "cata_type" : 3,
  "search_type" : "name",
  "page_size" : 0
}

响应示例

状态码:200

SUCCESS

{
  "status" : "success",
  "result" : {
    "page_no" : 1,
    "page_size" : 0,
    "total_page" : 0,
    "total_size" : 0,
    "page_list" : [ {
      "id" : "ab36b614545b49cb8b7c58f623974bbf",
      "warningMsg" : null,
      "source" : "",
      "method" : "",
      "description" : null,
      "nameView" : null,
      "tmssCaseNumber" : null,
      "region" : null,
      "yamlName" : null,
      "create_time_string" : "2025-06-12 19:37:56 GMT+08:00",
      "update_time_string" : "2025-06-12 19:37:56 GMT+08:00",
      "create_time_stamp" : 1749728276000,
      "update_time_stamp" : 1749728276000,
      "create_user" : "fdc93bccd8d040778701d4d35a4a4313",
      "create_time" : "2025-06-12T07:37:56+0800",
      "update_user" : "fdc93bccd8d040778701d4d35a4a4313",
      "update_time" : "2025-06-12T07:37:56+0800",
      "name" : "默认文件夹",
      "param_type_and_dft_value" : null,
      "dft_custom_header" : null,
      "dft_check_point_list" : null,
      "dft_variable_list" : null,
      "keyword_variable_value" : null,
      "dft_retry_times" : null,
      "dft_retry_interval" : null,
      "return_type" : null,
      "aw_type" : 0,
      "aw_ins_list" : null,
      "project_id" : "52784060e4394f1b94361bb1809c2588",
      "public_aw_lib_id" : null,
      "special_type" : null,
      "has_code" : null,
      "aw_code" : null,
      "group_name" : null,
      "protocol_type" : null,
      "by_order" : null,
      "aw_mark" : null,
      "output_param_list" : null,
      "is_favorite" : null,
      "tmss_case_id" : null,
      "create_user_id" : null,
      "aw_description" : null,
      "origin_project" : null,
      "aw_uniqueid" : null,
      "aw_tags" : null,
      "aw_operationid" : null,
      "interface_label" : null,
      "import_package" : null,
      "public_aw_lib" : null,
      "root_id" : null,
      "custom_aw_libs" : null,
      "delete_time" : null,
      "delete_user" : null,
      "parent_id" : "TOP",
      "is_folder" : "0",
      "cata_type" : 4,
      "page_no" : null,
      "page_size" : null,
      "total_page" : null,
      "total_size" : null,
      "child_list" : [ ],
      "extra_info" : null
    }, {
      "id" : "50baa6c0ba554b4db9dc856c8aed960d",
      "warningMsg" : null,
      "source" : "",
      "method" : "",
      "description" : "GRAYTEST DOCHECK",
      "nameView" : null,
      "tmssCaseNumber" : null,
      "region" : null,
      "yamlName" : null,
      "create_time_string" : "2025-06-12 19:49:18 GMT+08:00",
      "update_time_string" : "2025-06-12 19:49:18 GMT+08:00",
      "create_time_stamp" : 1749728958000,
      "update_time_stamp" : 1749728958000,
      "create_user" : "CloudTest-0704",
      "create_time" : "2025-06-12T07:49:18+0800",
      "update_user" : "CloudTest-0704",
      "update_time" : "2025-06-12T07:49:18+0800",
      "name" : "GRAYTEST DOCHECK",
      "param_type_and_dft_value" : null,
      "dft_custom_header" : null,
      "dft_check_point_list" : null,
      "dft_variable_list" : null,
      "keyword_variable_value" : null,
      "dft_retry_times" : null,
      "dft_retry_interval" : null,
      "return_type" : null,
      "aw_type" : 0,
      "aw_ins_list" : null,
      "project_id" : "52784060e4394f1b94361bb1809c2588",
      "public_aw_lib_id" : null,
      "special_type" : null,
      "has_code" : null,
      "aw_code" : null,
      "group_name" : null,
      "protocol_type" : null,
      "by_order" : null,
      "aw_mark" : null,
      "output_param_list" : null,
      "is_favorite" : null,
      "tmss_case_id" : null,
      "create_user_id" : null,
      "aw_description" : null,
      "origin_project" : null,
      "aw_uniqueid" : null,
      "aw_tags" : null,
      "aw_operationid" : null,
      "interface_label" : null,
      "import_package" : null,
      "public_aw_lib" : null,
      "root_id" : null,
      "custom_aw_libs" : null,
      "delete_time" : null,
      "delete_user" : null,
      "parent_id" : "TOP",
      "is_folder" : "0",
      "cata_type" : 1,
      "page_no" : null,
      "page_size" : null,
      "total_page" : null,
      "total_size" : null,
      "child_list" : [ ],
      "extra_info" : null
    } ]
  },
  "reason" : null,
  "error" : null
}

状态码

状态码

描述

200

SUCCESS

401

Unauthorized

403

Forbidden

404

Not Found

500

ERROR

错误码

请参见错误码

相关文档