Create Report Template¶

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

请求格式¶

POST https://{api-gateway}/report-design-service/v1.0/report-file/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	报表模板的自定义 ID，由用户指定。参数值需满足以下要求：自定义模板的 `reportKey` 需保证在当前 OU 中的唯一性。标准模板的 `reportKey` 需保证全局唯一，即在所有 OU 中唯一。
supportLanguage	可选	String	支持的语言，例如 zh_CN、en_US 等，按逗号分隔。默认为 en_US。

备注

如新建报表模板时指定了 reportKey ，后续可以使用该参数值来查询或删除相关报表模板。更新报表模板时可以更新 reportKey 参数值。
如新建报表模板时未指定 reportKey ，可以在更新报表模板时指定。

响应参数¶

名称	数据类型	描述
reportId	String	各版本报表模板的唯一 ID，新建或更新报表模板时由接口返回。该参数值随报表模板的变更而更新。
originalId	String	报表模板的初始 ID，新建报表模板时由接口返回。该参数值不随模板的更新而改变。
reportKey	String	报表模板的自定义 ID，由用户指定。

备注

请保留好接口返回的 originalId ，后续在更新、查询或删除报表模板时使用。
报表模板的各历史版本可通过 reportId 追溯，进行查询、删除等操作。

返回内容类型¶

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"
    }
}