文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 自定义测试服务用例管理/ 查询用户自定义配置
更新时间：2025-06-26 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询用户自定义配置

功能介绍

查询用户自定义配置

调用方法

请参见如何调用API。

URI

GET /v4/projects/{project_uuid}/user-defined-configs

表1 路径参数

参数

是否必选

参数类型

描述

project_uuid

是

String

项目UUID，项目唯一标识，固定长度32位字符（字母和数字）。获取方式请参见获取项目ID
表2 Query参数

参数

是否必选

参数类型

描述

type

是

String

类型（1:用例状态 2：用例结果 3：测试套状态 4：测试套结果）

service_type

否

String

服务类型

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

status

String

success|error

result

ResultValueListProjectDefinedStatusConfigVo object

请求的返回的数据对象

error

ApiError object

失败时的error信息

request_id

String

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

server_address

String

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

参数

参数类型

描述

total

Integer

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

value

Array of ProjectDefinedStatusConfigVo objects

实际的数据类型：单个对象，集合 或 NULL

reason

String

业务失败的提示内容

page_size

Integer

每页展示条数

page_no

Integer

页码

has_more

Boolean

是否有更多
表5 ProjectDefinedStatusConfigVo

参数

参数类型

描述

uri

String

资源URI

code

Integer

数值

name

String

名称

position

Integer

位置

flag

Integer

修改标识，0：不可修改 1：可修改

sort

Integer

顺序

type

String

自定义配置类型，类型（1:用例状态，2:用例结果，3:测试套状态，4:测试套结果）

project_id

String

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

region

String

region id
表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

参数解释:

接口调用失败错误信息

取值范围:

不涉及

请求示例

查询用户自定义配置

get https://{endpoint}/v4/projects/907d6252400e4dafb33f489ba1510a1b/user-defined-configs?project_uuid=907d6252400e4dafb33f489ba1510a1b&type=3

响应示例

状态码：200

OK

{
  "status" : "success",
  "result" : {
    "value" : [ {
      "uri" : "v91j0000vrqirl8b",
      "code" : 0,
      "name" : "新建",
      "flag" : 0,
      "sort" : 1,
      "type" : "3",
      "region" : "cn-north-7"
    }, {
      "uri" : "v91j0vrqirl8bjh4",
      "code" : 5,
      "name" : "设计中",
      "flag" : 0,
      "sort" : 2,
      "type" : "3",
      "region" : "cn-north-7"
    }, {
      "uri" : "v91j0vrqirl8bjh5",
      "code" : 6,
      "name" : "测试中",
      "flag" : 0,
      "sort" : 3,
      "type" : "3",
      "region" : "cn-north-7"
    }, {
      "uri" : "v91j0vrqirl8bjh6",
      "code" : 7,
      "name" : "完成",
      "flag" : 0,
      "sort" : 4,
      "type" : "3",
      "region" : "cn-north-7"
    } ]
  }
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

相关文档