Query Series Report Template¶

To query a report template or its previous versions by specifying organization ID, report template ID, or other parameters.

Request Format¶

GET https://{api-gateway}/report-design-service/v1.0/report-file/list/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>>
type	Query	Optional	String	To query custom templates, enter `cus`; for standard templates, enter `std`. If it is empty, all templates will be queried.
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

Among reportId, reportKey, and originalId, when any one is specified, the type parameter becomes invalid. When all are empty, all the latest report templates under the OU will be queried.
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 the RPT file has its template.
supportLanguage	List<String>	The supported languages of the template if the RPT file has its template.

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/list/query?orgId=yourOrgId&originalId=ddaa91a6723c9d111758c1cf52b14d8f&reportKey=yourReportKey

Response Sample¶

{
    "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"
    }]
}