Query Series Report Template


通过指定组织 ID、报表模板 ID 等参数来查询多个报表模板或某个报表模板的多个历史修改版本。

请求格式


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

请求参数 (URI)


名称

位置 (Path/Query)

必需/可选

数据类型

描述

orgId

Query

必需

String

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

type

Query

可选

String

查询自定义模板,输入 cus;标准模板,输入 std。若为空,则查询全部模板。

reportId

Query

可选

String

各版本报表模板的唯一 ID,新建或更新报表模板时由接口返回。该参数值随报表模板的变更而更新。如何获取 reportId>>

reportKey

Query

可选

String

报表模板的自定义 ID,由用户指定。如何获取 reportKey>>

originalId

Query

可选

String

报表模板的初始 ID,新建报表模板时由接口返回。该参数值不随模板的更新而改变。如何获取 originalId>>


备注

  • reportIdreportKeyoriginalId 中,当指定了任意一个时,type 参数失效。当全部为空时,将查询 OU 下全部最新的报表模板。

  • 如请求中使用了多个指定报表模板的参数,系统按照如下优先级来查询:

    originalId (最高)> reportId > reportKey (最低)。


响应参数


名称

数据类型

描述

reportId

String

各版本报表模板的唯一 ID,新建或更新报表模板时由接口返回。该参数值随报表模板的变更而更新。

reportKey

String

报表模板的自定义 ID,由用户指定。

originalId

String

报表模板的初始 ID,新建报表模板时由接口返回。该参数值不随模板的更新而改变。

createTime

String

报表模板的创建时间。

name

i18NObject

当 RPT 文件有对应的模板时,返回模板名称。

supportLanguage

List<String>

当 RPT 文件有对应的模板时,返回模板支持的语言。

返回内容类型


multipart/form-data

返回码


参见 报表工具 API 返回码

示例

请求示例


#requestURI:
GET https://{api-gateway}/report-design-service/v1.0/report-file/list/query?orgId=yourOrgId&originalId=ddaa91a6723c9d111758c1cf52b14d8f&reportKey=yourReportKey

返回示例


{
    "msg": "OK",
    "code": 0,
    "data": [{
      "reportId": "002443f7b9a513b834b187999c6d8855",
      "type": "cus",
      "category": "R",
      "createTime": "2021-02-03 06:57:53",
      "originalId": "ddaa91a6723c9d111758c1cf52b14d8f",
      "name": {
        "defaultValue": "KT"
      },
      "supportLanguage": [
        "en_US",
        "zh_CN",
        "ja_JP"
      ]
    },
    {
      "reportId": "003c9e7e0a1b8b68783c5b11288397e2",
      "type": "cus",
      "category": "R",
      "createTime": "2021-04-02 02:35:20",
      "originalId": "ddaa91a6723c9d111758c1cf52b14d8f"
    }]
}