Query Series Report Template¶

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

请求格式¶

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

请求参数 (URI)¶

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

请求参数 (Body)¶

名称	必需/可选	数据类型	描述
type	可选	String	查询自定义模板，输入 `cus`；标准模板，输入 `std`。若为空，则查询全部模板。
reportId	可选	String	报表模板的 ID。如何获取 reportId>>
reportKey	可选	String	报表模板的密钥（key）。如何获取 reportKey>> 模板密钥需满足以下要求：自定义模板的密钥需保证在当前 OU 中的唯一性。标准模板的密钥需保证全局唯一，即在所有 OU 中唯一。
originalId	可选	String	报表模板的源 ID。如何获取 originalId>>

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

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

reportId、reportKey 和 originalId 中，当指定了任意一个时，type 参数失效。当全部为空时，将查询 OU 下全部最新的报表模板。

响应参数¶

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

返回内容类型¶

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": "002443f7b9a513b834b187999c6d8855",
      "type": "cus",
      "category": "R",
      "createTime": "2021-02-03 06:57:53",
      "originalId": "002443f7b9a513b834b187999c6d8855",
      "name": {
        "defaultValue": "KT"
      },
      "supportLanguage": [
        "en_US",
        "zh_CN",
        "ja_JP"
      ]
    },
    {
      "reportId": "003c9e7e0a1b8b68783c5b11288397e2",
      "type": "cus",
      "category": "R",
      "createTime": "2021-04-02 02:35:20",
      "originalId": "d73b6ce9214ff8d797d3ad4d88fed4b4"
    }]
}