Update Report Template


通过上传新的 BIRT 报表设计文件(rptdesign)或库文件(rptlibrary)更新报表模板。

请求格式


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

请求参数 (URI)


名称

位置 (Path/Query)

必需/可选

数据类型

描述

orgId

Query

必需

String

报表模板所属组织的 ID。如何获取 orgID>>

请求参数 (Body)


名称

必需/可选

数据类型

描述

type

必需

String

如果新模板为自定义模板,使用 cus;如果新模板为标准模板,使用 std

originalId

必需

String

报表模板的源 ID。如何获取 originalId>>

fileName

可选

String

RPT 文件的名称。

fileUrl

可选

String

RPT 文件存放位置的 URL。若同时指定 fileUrlfileBase64 ,将以 fileUrl 为准。若二者都不指定,表示不更新 RPT 文件。

fileBase64

可选

String

base64 编码的 RPT 文件。若同时指定 fileUrlfileBase64 ,将以 fileUrl 为准。若二者都不指定,表示不更新 RPT 文件。

reportKey

可选

String

报表模板的密钥(key)。如何获取 reportKey>> 模板密钥需满足以下要求:

  • 自定义模板的密钥需保证在当前 OU 中的唯一性。

  • 标准模板的密钥需保证全局唯一,即在所有 OU 中唯一。

注意 如果通过指定 reportKey 来更新报表模板,需将密钥保存好,以供后续(如:查询模板)使用。

supportLanguage

可选

String

支持的语言,例如 zh_CN、en_US 等,按逗号分隔。默认为 en_US。

响应参数


名称

必需/可选

数据类型

描述

reportId

必需

String

报表的唯一 ID。

originalId

必需

String

上传报表后,接口返回的第一个 reportId

reportKey

可选

String

上传了报表模板密钥(Key)后,返回的密钥。

返回内容类型


multipart/form-data

返回码


参见 报表工具 API 返回码

示例

请求示例


#requestURL:
POST https://{api-gateway}/report-design-service/v1.0/report-file/update?orgId=yourOrgId
#requestbody:
{
    "fileUrl": "https%3A%2F%2Fenossolarcn.blob.core.chinacloudapi.cn%2Fpdc1%2Fnative-report-system%2Freport-file%2Fcustomized%2Fo15891646475831%2Frptdesign%2F138552a2b07ed1f8a0ec34d08c8c3e03.zip%3Fsv%3D2019-10-10%26st%3D2020-12-16T01%253A47%253A22Z%26se%3D2020-12-17T01%253A47%253A22Z%26sr%3Db%26sp%3Dr%26sig%3DqWUajh6OKHcfBjH3r8jOVZLRysT%252FFe1JuuHdnHh4jMo%253D",
    "reportKey": "yourReportKey",
    "type": "cus"
}

返回示例


返回成功示例:

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


返回失败示例:

{
    "msg": "Report key yourEnteredKey is not consistent with the root key ",
    "code": 93030,
    "success": false
}