Query Report Template¶

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

请求格式¶

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

请求参数 (URI)¶

名称	位置 (Path/Query)	必需/可选	数据类型	描述
orgId	Query	必需	String	报表模板所属组织的 ID。如何获取 orgID>>
reportId	Query	可选	String	各版本报表模板的唯一 ID，新建或更新报表模板时由接口返回。该参数值随报表模板的变更而更新。如何获取 reportId>>
reportKey	Query	可选	String	报表模板的自定义 ID，由用户指定。如何获取 reportKey>>
originalId	Query	可选	String	报表模板的初始 ID，新建报表模板时由接口返回。该参数值不随模板的更新而改变。如何获取 originalId>>

备注

reportId、reportKey 和 originalId 均为可选参数，但在一次请求中必须使用至少其中一个参数。
如请求中使用了多个指定报表模板的参数，系统按照如下优先级来查询：
originalId （最高）> reportId > reportKey （最低）。

响应参数¶

名称	数据类型	描述
reportId	String	各版本报表模板的唯一 ID，新建或更新报表模板时由接口返回。该参数值随报表模板的变更而更新。
reportKey	String	报表模板的自定义 ID，由用户指定。
originalId	String	报表模板的初始 ID，新建报表模板时由接口返回。该参数值不随模板的更新而改变。
createTime	String	报表模板的创建时间。
name	i18NObject	模板名称（如有）。
supportLanguage	List<String>	模板支持的语言（如有）。

返回内容类型¶

multipart/form-data

返回码¶

参见报表工具 API 返回码。

示例¶

请求示例¶

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

返回示例¶

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