Generate Report¶

基于报表模板，以多种格式生成报表。

请求格式¶

POST https://{api-gateway}/report-runtime-service/v1.0/report?action=create

请求参数 (URI)¶

名称	位置 (Path/Query)	必需/可选	数据类型	描述
orgId	Query	必需	String	报表模板所属组织的 ID。如何获取 orgId>>

请求参数 (Body)¶

备注

reportId、reportKey 和 originalId 均为可选参数，但在一次请求中必须使用至少其中一个参数。

名称	必需/可选	数据类型	描述
dynamicParameters	可选	Parameter 结构体	动态参数。如果不传此参数，则用模板的默认参数。查询报表模板参数>>
reportKey	可选	String	报表模板的自定义 ID，由用户指定。如何获取 reportKey>>
reportId	可选	String	各版本报表模板的唯一 ID，新建或更新报表模板时由接口返回。该参数值随报表模板的变更而更新。如何获取 reportId>>
originalId	可选	String	报表模板的初始 ID，新建报表模板时由接口返回。该参数值不随模板的更新而改变。如何获取 originalId>>
outputFormat	可选	String	报表输出格式，支持 `pdf`、`docx` 或 `xlsx`。默认值为 `pdf`。
local	可选	String	语言。中文：`zh_CN`，英文：`en_US`。默认为 `en_US`。

Parameter 结构体¶

参数名称	必需/可选	数据类型	描述
paramKey	必需	String	参数名称。查询报表模板参数>>
paramValue	必需	String	paramKey 的参数值。

响应参数¶

名称	数据类型	描述
outputFileId	String	输出报表的 uuid。
outputFilePath	String	输出报表的 URL，用于获取生成的报表。该参数值经 URL 编码，需解码后使用。
generateTaskId	String	该任务执行的 uuid。
createTime	String	报表的生成时间。
outputFormat	String	报表的输出格式。
validTime	String	报表的有效时间。

返回内容类型¶

application/json

返回码¶

参见报表工具 API 返回码。

示例¶

请求示例¶

#requestURI:
POST https://{api-gateway}/report-runtime-service/v1.0/report?orgId=yourOrgId&action=create
#requestBody:
{
    "reportId": "ddaa91a6723c9d111758c1cf52b14d8f",
     "reportKey": "yourReportKey",
     "originalId: "ddaa91a6723c9d111758c1cf52b14d8f",
    "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
    }
}