Query Report Template¶

To query a report template by specifying organization ID, report template ID, and other parameters.

Request Format¶

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

Request Parameters (URI)¶

Name	Location (Path/Query)	Mandatory/Optional	Data Type	Description
orgId	Query	Mandatory	String	The ID of the organization which the report templates belong to. How to get orgID>>
reportId	Query	Optional	String	The unique ID of each version of the report template, generated when you create or update the report template. How to get reportId>>
reportKey	Query	Optional	String	The custom ID of the report template, specified by the caller. How to get reportKey>>
originalId	Query	Optional	String	The original ID of the report template, generated when you create the template. The value of originalId remains unchanged regardless of modifications to the template. How to get originalId>>

Note

reportId, reportKey, and originalId are all optional, but you must use at least one of the parameters in the request.
If you use multiple parameters, EnOS Reporting Tool processes your request according to the following priority order:
originalId (highest) > reportId > reportKey (lowest).

Response Parameters¶

Name	Data Type	Description
reportId	String	The unique ID of each version of the report template, generated when you create or update the report template.
originalId	String	The original ID of the report template, generated when you create the template. The value of originalId remains unchanged regardless of modifications to the template.
reportKey	String	The custom ID of the report template, specified by the caller.
createTime	String	The create time of the report template.
name	i18NObject	The template name(if any).
supportLanguage	List<String>	The supported languages of the template(if any).

Response Content Type¶

multipart/form-data

Response Codes¶

See Reporting Tool API Response Codes.

Samples¶

Request Sample¶

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

Response Sample¶

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