Create Report Template¶

通过上传 BIRT 报表设计文件（rptdesign）或库文件（rptlibrary）新建报表模板。

请求格式¶

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

请求参数 (URI)¶

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

请求参数 (Body)¶

名称	必需/可选	数据类型	描述
type	必需	String	如果新建自定义模板，使用 `cus`；如果新建标准模板，使用 `std`。
fileName	必需	String	RPT 文件的名称，将作为模板名称。
fileUrl	可选	String	RPT 文件存放位置的 URL。系统管理员可配置 URL 白名单，若请求的参数值不在白名单内，则请求失败。fileUrl 和 fileBase64 必须指定一个，若同时指定，将以 fileUrl 为准。
fileBase64	可选	String	base64 编码的 RPT 文件。fileUrl 和 fileBase64 必须指定一个，若同时指定，将以 fileUrl 为准。
reportKey	可选	String	报表模板的密钥（key）。模板密钥需满足以下要求：自定义模板的密钥需保证在当前 OU 中的唯一性。标准模板的密钥需保证全局唯一，即在所有 OU 中唯一。注意如果通过指定 reportKey 来新建报表模板，需将密钥保存好，以供后续（如：查询模板）使用。
supportLanguage	可选	String	支持的语言，例如 zh_CN、en_US 等，按逗号分隔。默认为 en_US。

响应参数¶

名称	数据类型	描述
reportId	String	报表的唯一 ID。
originalId	String	上传报表后，接口返回的第一个 `reportId`。
reportKey	String	上传了报表模板密钥（key）后，返回的密钥。

备注

请保存好返回的 reportId，该 ID 将在后续对该模板进行更新或其他操作时用作 originalId。

返回内容类型¶

multipart/form-data

返回码¶

参见报表工具 API 返回码。

示例¶

请求示例¶

#requestURI:
POST https://{api-gateway}/report-design-service/v1.0/report-file/create?orgId=yourOrgId
#requestBody:
{
    "fileUrl": "https://your.file.server.domain/yourTemplate.rpt",
    "reportKey": "yourReportKey",
    "fileName": "yourFileName",
    "type": "cus"
}

返回示例¶

{
    "msg": "OK",
    "code": 0,
    "data": {
        "reportId": "ddaa91a6723c9d111758c1cf52b14d8f",
        "originalId": "ddaa91a6723c9d111758c1cf52b14d8f",
        "reportKey":"uuid"
    }
}