查询接口自动化数据 - 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	参数解释接口调用失败错误码取值范围不超过256个字符组成的字符串
error	CommonResponseErrorScheduleDataResponse object	参数解释统一错误返回取值范围不涉及
reason	String	参数解释接口调用失败原因取值范围不超过1000个字符组成的字符串
result	ScheduleDataResponse object	参数解释结果取值范围不涉及
status	String	参数解释 '状态值，如success、error' 取值范围 success，请求成功 error，请求报错

表5 CommonResponseErrorScheduleDataResponse
参数	参数类型	描述
code	String	参数解释接口调用失败错误码取值范围不超过256个字符组成的字符串
detail	ScheduleDataResponse object	参数解释错误信息详情取值范围不涉及
reason	String	参数解释接口调用失败原因取值范围不超过1000个字符组成的字符串

表6 ScheduleDataResponse
参数	参数类型	描述
casesExecutableState	Map<String,Boolean>	用例是否是可执行状态
containMediaPublicAw	Boolean	是否包含Media公共资源
variableGroupID	String	参数解释全局环境分组唯一标识取值范围 32个字符组成的字符串

状态码：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

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