跳转到内容

报告

报表配置与管理 - 提供统一的入口用于配置和管理报表设置,便于高效定制和监管报表流程


查询报告列表

GET
/api/v1/report

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

查询参数

id
类型integer
format"int64"
projectId*

项目ID

类型integer
必填
format"int64"
name
类型string
status
类型string
枚举
"PENDING""SUCCESS""FAILURE"
category
类型string
枚举
"PROJECT""TASK""FUNCTIONAL""APIS""SCENARIO""EXECUTION"
template
类型string
枚举
"PROJECT_PROGRESS""PROJECT_DATA_ASSETS""PROJECT_EFFICIENCY""PROJECT_ACTIVITY""TASK_SPRINT""TASK""FUNC_TESTING_PLAN""FUNC_TESTING_CASE""SERVICES_TESTING_RESULT""APIS_TESTING_RESULT""SCENARIO_TESTING_RESULT""EXEC_FUNCTIONAL_RESULT""EXEC_PERFORMANCE_RESULT""EXEC_STABILITY_RESULT""EXEC_CUSTOMIZATION_RESULT"
targetId
类型integer
format"int64"
targetType
类型string
枚举
"PROJECT""TAG""MODULE""TASK""TASK_SPRINT""SOFTWARE_VERSION""TASK_ANALYSIS""MEETING""FUNC_PLAN""FUNC_REVIEW""FUNC_CASE""FUNC_CASE_BASELINE""FUNC_CASE_ANALYSIS""SERVICE""API""API_CASE""API_DESIGN""SCENARIO""SCENARIO_MONITOR""SCRIPT""MOCK_SERVICE""VARIABLE""DATASET""MOCK_APIS""EXECUTION""REPORT"
nextGenerationDate
类型string
format"date-time"
createdBy
类型integer
format"int64"
createdDate
类型string
format"date-time"
lastModifiedBy
类型integer
format"int64"
lastModifiedDate
类型string
format"date-time"
pageNo

页面数据大小,默认为1,最大值为100000

类型integer
format"int32"
maximum100000
minimum1
pageSize

页面数据大小,默认为10,最大值为2000

类型integer
format"int32"
maximum2000
minimum1
orderBy

排序字段

类型string
orderSort

排序方式

类型string
枚举
"ASC""DESC"
filters[0].key

筛选字段名称

类型string
filters[0].op

过滤条件(等于、不等于、大于等)

类型string
枚举
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"
filters[0].value

筛选值

类型object
filters[1].key

筛选字段名称

类型string
filters[1].op

过滤条件(等于、不等于、大于等)

类型string
枚举
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"
filters[1].value

筛选值

类型object
filters[2].key

筛选字段名称

类型string
filters[2].op

过滤条件(等于、不等于、大于等)

类型string
枚举
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"
filters[2].value

筛选值

类型object
infoScope

查询信息范围

类型string
枚举
"BASIC""DETAIL"

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

替换报告

PUT
/api/v1/report

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json
JSON
"string"

响应

成功

*/*
JSON
"string"

试验场

授权
主体

示例

cURL
JavaScript
PHP
Python

添加报告

POST
/api/v1/report

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json
JSON
"string"

响应

成功

*/*
JSON
"string"

试验场

授权
主体

示例

cURL
JavaScript
PHP
Python

删除报告

DELETE
/api/v1/report

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

查询参数

ids*

报告ID

类型array
必填
maxItems200
minItems0
uniqueItemstrue

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

更新报告

PATCH
/api/v1/report

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

请求体

application/json
JSON
"string"

响应

成功

*/*
JSON
"string"

试验场

授权
主体

示例

cURL
JavaScript
PHP
Python

查询测试用例报告或记录的内容

GET
/api/v1/report/content/funcCase/{caseId}

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

caseId*

案件编号

类型integer
必填
format"int64"

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

查询报告详情

GET
/api/v1/report/{id}

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

id*

报告ID

类型integer
必填
format"int64"

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

对报告列表进行全文搜索

GET
/api/v1/report/search
UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

查询参数

id
类型integer
format"int64"
projectId*

项目ID

类型integer
必填
format"int64"
name
类型string
status
类型string
枚举
"PENDING""SUCCESS""FAILURE"
category
类型string
枚举
"PROJECT""TASK""FUNCTIONAL""APIS""SCENARIO""EXECUTION"
template
类型string
枚举
"PROJECT_PROGRESS""PROJECT_DATA_ASSETS""PROJECT_EFFICIENCY""PROJECT_ACTIVITY""TASK_SPRINT""TASK""FUNC_TESTING_PLAN""FUNC_TESTING_CASE""SERVICES_TESTING_RESULT""APIS_TESTING_RESULT""SCENARIO_TESTING_RESULT""EXEC_FUNCTIONAL_RESULT""EXEC_PERFORMANCE_RESULT""EXEC_STABILITY_RESULT""EXEC_CUSTOMIZATION_RESULT"
targetId
类型integer
format"int64"
targetType
类型string
枚举
"PROJECT""TAG""MODULE""TASK""TASK_SPRINT""SOFTWARE_VERSION""TASK_ANALYSIS""MEETING""FUNC_PLAN""FUNC_REVIEW""FUNC_CASE""FUNC_CASE_BASELINE""FUNC_CASE_ANALYSIS""SERVICE""API""API_CASE""API_DESIGN""SCENARIO""SCENARIO_MONITOR""SCRIPT""MOCK_SERVICE""VARIABLE""DATASET""MOCK_APIS""EXECUTION""REPORT"
nextGenerationDate
类型string
format"date-time"
createdBy
类型integer
format"int64"
createdDate
类型string
format"date-time"
lastModifiedBy
类型integer
format"int64"
lastModifiedDate
类型string
format"date-time"
pageNo

页面数据大小,默认为1,最大值为100000

类型integer
format"int32"
maximum100000
minimum1
pageSize

页面数据大小,默认为10,最大值为2000

类型integer
format"int32"
maximum2000
minimum1
orderBy

排序字段

类型string
orderSort

排序方式

类型string
枚举
"ASC""DESC"
filters[0].key

筛选字段名称

类型string
filters[0].op

过滤条件(等于、不等于、大于等)

类型string
枚举
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"
filters[0].value

筛选值

类型object
filters[1].key

筛选字段名称

类型string
filters[1].op

过滤条件(等于、不等于、大于等)

类型string
枚举
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"
filters[1].value

筛选值

类型object
filters[2].key

筛选字段名称

类型string
filters[2].op

过滤条件(等于、不等于、大于等)

类型string
枚举
"GREATER_THAN""LESS_THAN""GREATER_THAN_EQUAL""LESS_THAN_EQUAL""EQUAL""NOT_EQUAL""MATCH""MATCH_END""NOT_MATCH""NOT_MATCH_END""IN""NOT_IN""IS_NULL""IS_NOT_NULL"
filters[2].value

筛选值

类型object
infoScope

查询信息范围

类型string
枚举
"BASIC""DETAIL"

成功

*/*
JSON
"string"
授权
变量
cURL
JavaScript
PHP
Python

查询报告内容

GET
/api/v1/report/{id}/content

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

id*

报告ID

类型integer
必填
format"int64"

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

立即生成报告

POST
/api/v1/report/{id}/generate/now

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

id*

报告ID

类型integer
必填
format"int64"

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

查询任务报告或记录的内容

GET
/api/v1/report/content/task/{taskId}

授权

UserHttpBearer

使用现有不透明令牌进行身份验证

类型HTTP (bearer)

参数

路径参数

taskId*

任务ID

类型integer
必填
format"int64"

响应

成功

*/*
JSON
"string"

试验场

授权
变量

示例

cURL
JavaScript
PHP
Python

基于 GPL-3.0 许可发布