刷新自定义模板报表
功能介绍
刷新自定义模板报表
调用方法
请参见如何调用API。
URI
POST /v4/{project_id}/versions/{version_uri}/custom-template-reports/refresh
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目UUID,项目唯一标识,固定长度32位字符(字母和数字)。获取方式请参见获取项目ID。 |
version_uri |
是 |
String |
版本uri |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
uri |
否 |
String |
报表id |
name |
否 |
String |
报表名称 |
type |
否 |
Integer |
报表类型 1:首页用例库, 2:质量报告 |
workpiece_type |
否 |
String |
工件类型(用例:case,测试套:suite) |
template_config |
否 |
CustomTemplateFilter object |
模板配置 |
data |
否 |
Array of CustomTemplateReportData objects |
统计结果 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
feature_uris |
否 |
Array of strings |
目录uri |
template_name |
否 |
String |
模板名称 |
template_uri |
否 |
String |
模板uri |
column_configs |
否 |
Array of ReportTemplateColumnConfig objects |
字段配置 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
filter |
否 |
LogicFilterOperator object |
过滤条件 |
column_name |
否 |
String |
字段名称 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
logic_operator |
否 |
String |
逻辑操作 |
field_name |
否 |
String |
字段名称值 |
field_name_key |
否 |
String |
字段名称key |
field_value |
否 |
String |
字段值 |
field_value_key |
否 |
String |
字段key |
field_operator |
否 |
String |
字段操作 |
logic_filters |
否 |
Array of LogicFilterOperator objects |
过滤条件 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
feature_name |
否 |
String |
目录名称 |
data |
否 |
Array of ColumnDataVo objects |
列数据 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
status |
String |
状态 |
result |
result object |
结果 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释 接口调用失败错误码 取值范围 不涉及 |
error_msg |
String |
参数解释 接口调用失败错误信息 取值范围 不涉及 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释 接口调用失败错误码 取值范围 不涉及 |
error_msg |
String |
参数解释 接口调用失败错误信息 取值范围 不涉及 |
状态码:404
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释 接口调用失败错误码 取值范围 不涉及 |
error_msg |
String |
参数解释 接口调用失败错误信息 取值范围 不涉及 |
状态码:500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释 接口调用失败错误码 取值范围 不涉及 |
error_msg |
String |
参数解释 接口调用失败错误信息 取值范围 不涉及 |
请求示例
post https://{endpoint}/v4/{project_id}/versions/{version_uri}/custom-template-reports/refresh { "uri" : "v90700010hbln9c3", "name" : "123", "type" : 0, "workpiece_type" : "case", "template_config" : { "feature_uris" : [ "v25866610hblntco" ], "template_name" : "模板名称", "template_uri" : "v80600010hbln9c3" } }
响应示例
状态码:200
刷新自定义模板报表返回体
{ "status" : "success", "result" : { "value" : "success" } }
状态码
状态码 |
描述 |
---|---|
200 |
刷新自定义模板报表返回体 |
400 |
Bad Request |
401 |
Unauthorized |
404 |
Not Found |
500 |
Internal Server Error |
错误码
请参见错误码。