Query Report Template


Query a report template by specifying the template ID, the organization ID, and other parameters.

Request Format


GET https://{api-gateway}/report-design-service/v1.0/report-file?action=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>>

Request Parameters (Body)


Name

Mandatory/Optional

Data Type

Description

reportId

Optional

String

The ID of the report template. How to get reportId>>

reportKey

Optional

String

The unique key of the new report template. How to get reportKey>> A report template key must meet these requirements:

  • For a custom report template, its key must be unique in the OU.

  • For a standard report template, its key must be unique across all OUs.

originalId

Optional

String

The root ID of the report template. How to get originalId>>


The priority of the parameters to designate a report template is as below:


originalId (highest) > reportId > reportKey (lowest).


reportId, reportKey, and originalId are all optional, but you must use at least one of the parameters in the request.

Response Parameters


Name

Mandatory/Optional

Data Type

Description

reportId

Mandatory

String

The unique ID of the report.

originalId

Mandatory

String

The first reportId the interface returned after uploading the template.

reportKey

Optional

String

The returned key after uploading the key of the report template.

createTime

Mandatory

String

The create time of the report template. Use the yyyy-MM-dd HH:mm:ss format.

name

Optional

i18NObject

The template name(if any).

supportLanguage

Optional

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/update?orgId=yourOrgId
#requestBody:
{
    "reportId": "ddaa91a6723c9d111758c1cf52b14d8f",
    "reportKey": "yourReportKey",
    "originalId":"ddaa91a6723c9d111758c1cf52b14d8f"
}

Response Sample


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