文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 接口测试管理/ 查询接口自动化数据 - ShowDesignData
更新时间:2025-12-27 GMT+08:00
分享

查询接口自动化数据 - ShowDesignData

功能介绍

查询接口自动化数据,给schedule服务提供的查询design数据汇总入口

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/query/designData

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及

取值范围:

项目uuid应符合如下规则:长度等于32位,包含大小写字母、数字

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

必传。

取值范围:

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

默认取值:

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

ShowDesignDataRequestBody

String

查询接口自动化数据请求参数

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

code

String

错误码

error

CommonResponseErrorScheduleDataResponse object

统一错误返回

reason

String

失败原因

result

ScheduleDataResponse object

结果

status

String

状态

  • success,请求成功

  • error,请求报错

表5 CommonResponseErrorScheduleDataResponse

参数

参数类型

描述

code

String

错误码

detail

ScheduleDataResponse object

错误信息详情

reason

String

错误原因

表6 ScheduleDataResponse

参数

参数类型

描述

casesExecutableState

Map<String,Boolean>

用例是否是可执行状态

containMediaPublicAw

Boolean

是否包含Media公共资源

variableGroupID

String

全局环境分组唯一标识

状态码:201

Created

状态码:401

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

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

error_msg

String

参数解释

接口调用失败错误信息

取值范围

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

状态码:403

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

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

error_msg

String

参数解释

接口调用失败错误信息

取值范围

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

状态码:404

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

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

error_msg

String

参数解释

接口调用失败错误信息

取值范围

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

请求示例

post https://{endpoint}/v1/afb336e9aeea4ee2b0965fc800c570bc/query/designData

"{
  "variableGroupID": "4536e5bb4cc8440997931948416beca6",
  "testcaseId": "v92s00010hrk1ohc",
  "testcaseIds": [
      "v92s00010hrk1ohc"
  ]
}"

响应示例

状态码:200

OK

{
  "status" : "success",
  "result" : {
    "variableGroupID" : "4536e5bb4cc8440997931948416beca6",
    "casesExecutableState" : {
      "v92s00010hrk1ohc" : true
    },
    "containMediaPublicAw" : false
  },
  "reason" : null,
  "error" : null,
  "code" : null
}

状态码

状态码

描述

200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

错误码

请参见错误码

相关文档