Generate Report¶
基于报表模板,以多种格式生成报表。
请求参数 (Body)¶
名称 | 必需/可选 | 数据类型 | 描述 |
---|---|---|---|
dynamicParameters | 可选 | List<Object> | 动态参数。 |
reportKey | 可选 | String | 报表模板的密钥(key)。如何获取 reportKey>> 模板密钥需满足以下要求:
|
reportId | 可选 | String | 报表模板的 ID。如何获取 reportId>> |
originalId | 可选 | String | 报表模板的源 ID。如何获取 originalId>> |
outputFormat | 可选 | String | 支持 pdf 、docx 或 xlsx 。默认值为 pdf 。 |
local | 可选 | String | 中文:zh_CN ,英文:en_US 。默认为 en_US 。 |
若本次生成的报表已同步私有参数,则在接口的动态参数列表中拼接私有参数,生成报表即可。
响应参数¶
名称 | 必需/可选 | 数据类型 | 描述 |
---|---|---|---|
outputFileId | 必需 | String | 输出报表的 uuid。 |
outputFilePath | 必需 | String | 输出报表的 URL。该参数的值是加密后的结果,需要在解密后使用。 |
generateTaskId | 必需 | String | 该任务执行的 uuid。 |
createTime | 可选 | String | 报表的生成时间。格式:yyyy-MM-dd HH:mm:ss 。 |
outputFormat | 可选 | String | 报表的输出格式。 |
validTime | 可选 | String | 报表的有效时间。 |
示例¶
请求示例¶
#requestURI:
POST https://{api-gateway}/report-runtime-service/v1.0/report?orgId=yourOrgId&action=create
#requestBody:
{
"reportId": "uuid(32)",
"reportKey": "report key",
"originalId:"original id",
"outputFormat": "pdf",
"locale":"en_US",
"dynamicParameters": [
{
"paramKey": "pointList",
"paramValue": "SITE.RadiationACC,SITE.ActiveProduction,SITE.FullHour,SITE.TBA_TotalTime"
},
{
"paramKey": "orgId",
"paramValue": "o15910828289691"
},
{
"paramKey": "mdmIds",
"paramValue": "c5a29074-2a07-4335-9f29-ba751cd82abf"
},
{
"paramKey": "startTime",
"paramValue": "2020-01-01"
},
{
"paramKey": "endTime",
"paramValue": "2020-12-31"
},
{
"paramKey": "token",
"paramValue": "Bearer APP_PORTAL_S_Fpt5XcjQcVYvutRYTCDCcV5H38BDS442"
},
{
"paramKey": "timeGroup",
"paramValue": "M"
}
]
}
返回示例¶
{
"msg": "OK",
"code": 0,
"data": {
"outputFileId": "0af6ce63375c6c9f876ac1f9632c1ccc",
"outputFilePath": "https%3A%2F%2Fenossolarcn.blob.core.chinacloudapi.cn%2Fpdc1%2Fnative-report-system%2Foutput-file%2F20201216%2Fo15891646475831%2Fcd7aac80adf7d0689d603e3c1dfe4480_20201216110211.pdf%3Fsig%3DHSPTm1EnJ6xIXJ2PjrIq7kHLIsDW16a%252FExQqx3%252F8w1w%253D%26st%3D2020-12-16T03%253A02%253A44Z%26se%3D2020-12-23T03%253A02%253A44Z%26sv%3D2019-02-02%26sp%3Dracwdl%26sr%3Db",
"generateTaskId": "46f0fe02256a5a24b23f7bcf4becd07a",
"createTime": "2020-12-16 03:00:02",
"outputFormat": "pdf",
"validTime": 604800
}
}
注解
生成的报表可在返回的 outputFilePath
中获取。