Query Report Template¶

通过指定报表模板 ID、组织 ID 等参数来查询单个报表模板。

请求格式¶

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

请求参数 (URI)¶

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

请求参数 (Body)¶

名称

必需/可选

数据类型

描述

reportId

可选

String

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

reportKey

可选

String

报表模板的密钥（key）。如何获取 reportKey>> 模板密钥需满足以下要求：

自定义模板的密钥需保证在当前 OU 中的唯一性。
标准模板的密钥需保证全局唯一，即在所有 OU 中唯一。

originalId

可选

String

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

指定报表模板的参数的优先级如下：

originalId（最高）> reportId > reportKey（最低）。

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

响应参数¶

名称	必需/可选	数据类型	描述
reportId	必需	String	报表模板的 ID。
reportKey	可选	String	上传了报表模板密钥（key）后，返回的密钥。
originalId	必需	String	上传报表后，接口返回的第一个 `reportId`。
createTime	必需	String	报表模板的创建时间。格式：`yyyy-MM-dd HH:mm:ss`。
name	可选	i18NObject	模板名称（如有）。
supportLanguage	可选	List<String>	模板支持的语言（如有）。

返回内容类型¶

multipart/form-data

返回码¶

参见报表工具 API 返回码。

示例¶

请求示例¶

#requestURI:
GET https://{api-gateway}/report-design-service/v1.0/report-file/update?orgId=yourOrgId
#requestBody:
{
    "reportId": "ddaa91a6723c9d111758c1cf52b14d8f",
    "reportKey": "yourReportKey"，
    "originalId":"ddaa91a6723c9d111758c1cf52b14d8f"
}

返回示例¶

{
    "msg": "OK",
    "code": 0,
    "data": {
        "reportId": "ddaa91a6723c9d111758c1cf52b14d8f",
        "originalId": "ddaa91a6723c9d111758c1cf52b14d8f",
        "reportKey":"uuid",
        "createTime" : "2020-12-16 03:00:02"
    }
}