XCan Cloud

English

简体中文

English

简体中文

Appearance

Report​

Report Configuration and Management - Provides a unified entry point for configuring and managing report settings, facilitating efficient customization and oversight of reporting processes.

Query the list of report​

GET
/api/v1/report

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

查询参数

id
类型integer
格式"int64"
projectId*

Project id

类型integer
必填
格式"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
格式"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
格式"date-time"
createdBy
类型integer
格式"int64"
createdDate
类型string
格式"date-time"
lastModifiedBy
类型integer
格式"int64"
lastModifiedDate
类型string
格式"date-time"
pageNo

Page data size, default 1, maximum 100000

类型integer
格式"int32"
最大值100000
最小值1
pageSize

Page data size, default 10, maximum 2000

类型integer
格式"int32"
最大值2000
最小值1
orderBy

Sort field

类型string
orderSort

Sorting method

类型string
有效值
"ASC""DESC"
filters[0].key

Filter field name

类型string
filters[0].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型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

Filter value

filters[1].key

Filter field name

类型string
filters[1].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型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

Filter value

filters[2].key

Filter field name

类型string
filters[2].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型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

Filter value

infoScope

Query information scope

类型string
有效值
"BASIC""DETAIL"

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
变量
键
值

示例​

cURL
JavaScript
PHP
Python

Replace report​

PUT
/api/v1/report

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体​

application/json
JSON
{
"id": 0,
"projectId": 0,
"name": "Example report",
"auth": true,
"version": 1,
"description": "string",
"category": "string",
"template": "string",
"createTimeSetting": {
"createdAt": "string",
"createdAtSomeDate": "string",
"periodicCreationUnit": "string",
"dayOfWeek": "string",
"dayOfMonth": 0,
"timeOfDay": "14:30:00"
},
"basicInfoSetting": {
"reportContacts": "string",
"reportCopyright": "string",
"otherInformation": "string",
"watermark": "string"
},
"contentSetting": {
"filter": {
"targetType": "string",
"targetId": 0,
"creatorObjectType": "string",
"creatorObjectId": 0,
"planOrSprintId": 0,
"createdDateStart": "string",
"createdDateEnd": "string"
},
"catalogContent": {
"additionalProperties": {
}
}
}
}

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
主体

示例​

cURL
JavaScript
PHP
Python

Add report​

POST
/api/v1/report

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体​

application/json
JSON
{
"projectId": 0,
"name": "Example report",
"auth": true,
"version": 1,
"description": "string",
"category": "string",
"template": "string",
"createTimeSetting": {
"createdAt": "string",
"createdAtSomeDate": "string",
"periodicCreationUnit": "string",
"dayOfWeek": "string",
"dayOfMonth": 0,
"timeOfDay": "14:30:00"
},
"basicInfoSetting": {
"reportContacts": "string",
"reportCopyright": "string",
"otherInformation": "string",
"watermark": "string"
},
"contentSetting": {
"filter": {
"targetType": "string",
"targetId": 0,
"creatorObjectType": "string",
"creatorObjectId": 0,
"planOrSprintId": 0,
"createdDateStart": "string",
"createdDateEnd": "string"
},
"catalogContent": {
"additionalProperties": {
}
}
}
}

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
主体

示例​

cURL
JavaScript
PHP
Python

Delete report​

DELETE
/api/v1/report

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

查询参数

ids*

Report ids

类型array
必填
最大项数200
最小项数0
唯一项true

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
变量
键
值

示例​

cURL
JavaScript
PHP
Python

Update report​

PATCH
/api/v1/report

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

请求体​

application/json
JSON
{
"id": 0,
"name": "Example report",
"version": 1,
"description": "string",
"createTimeSetting": {
"createdAt": "string",
"createdAtSomeDate": "string",
"periodicCreationUnit": "string",
"dayOfWeek": "string",
"dayOfMonth": 0,
"timeOfDay": "14:30:00"
},
"basicInfoSetting": {
"reportContacts": "string",
"reportCopyright": "string",
"otherInformation": "string",
"watermark": "string"
},
"contentSetting": {
"filter": {
"targetType": "string",
"targetId": 0,
"creatorObjectType": "string",
"creatorObjectId": 0,
"planOrSprintId": 0,
"createdDateStart": "string",
"createdDateEnd": "string"
},
"catalogContent": {
"additionalProperties": {
}
}
}
}

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
主体

示例​

cURL
JavaScript
PHP
Python

Generate report now​

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

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

路径参数

id*

Report id

类型integer
必填
格式"int64"

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
变量
键
值

示例​

cURL
JavaScript
PHP
Python

Query the detail of report​

GET
/api/v1/report/{id}

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

路径参数

id*

Report id

类型integer
必填
格式"int64"

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
变量
键
值

示例​

cURL
JavaScript
PHP
Python

Query the content of report​

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

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

路径参数

id*

Report id

类型integer
必填
格式"int64"

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
变量
键
值

示例​

cURL
JavaScript
PHP
Python

Fulltext search the list of report​

GET
/api/v1/report/search

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

查询参数

id
类型integer
格式"int64"
projectId*

Project id

类型integer
必填
格式"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
格式"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
格式"date-time"
createdBy
类型integer
格式"int64"
createdDate
类型string
格式"date-time"
lastModifiedBy
类型integer
格式"int64"
lastModifiedDate
类型string
格式"date-time"
pageNo

Page data size, default 1, maximum 100000

类型integer
格式"int32"
最大值100000
最小值1
pageSize

Page data size, default 10, maximum 2000

类型integer
格式"int32"
最大值2000
最小值1
orderBy

Sort field

类型string
orderSort

Sorting method

类型string
有效值
"ASC""DESC"
filters[0].key

Filter field name

类型string
filters[0].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型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

Filter value

filters[1].key

Filter field name

类型string
filters[1].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型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

Filter value

filters[2].key

Filter field name

类型string
filters[2].op

Filter condition (EQUAL, NOT_EQUAL, GREATER_THAN, etc.)

类型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

Filter value

infoScope

Query information scope

类型string
有效值
"BASIC""DETAIL"

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}
授权
变量
键
值
cURL
JavaScript
PHP
Python

Query the content of task report or record​

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

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

路径参数

taskId*

Task id

类型integer
必填
格式"int64"

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
变量
键
值

示例​

cURL
JavaScript
PHP
Python

Query the content of testing case report or record​

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

授权​

UserHttpBearer

Use existing opaque tokens for authentication

类型HTTP (bearer)

参数​

路径参数

caseId*

Case id

类型integer
必填
格式"int64"

响应​

OK

*/*
JSON
{
"code": "string",
"msg": "string",
"data": {
},
"datetime": "string",
"ext": {
"additionalProperties": {
}
}
}

试验场​

授权
变量
键
值

示例​

cURL
JavaScript
PHP
Python

Released under the GPL-3.0 License.

Copyright © 2021-2025 XCan Cloud