Delete Report Template¶

Delete a report template.

Request Format¶

POST https://{api-gateway}/report-design-service/v1.0/report-file?action=delete

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)¶

Note

reportId, reportKey, and originalId are all optional, but you must use at least one of the parameters in the request.
The priority of the parameters to designate a report template is as below: reportId (highest) > originalId > reportKey (lowest).
reportId can be used to delete a single task, reportKey or originalId can be used to delete multiple tasks.

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>>

Response Content Type¶

application/json

Response Codes¶

See Reporting Tool API Response Codes.

Samples¶

Request Sample¶

#requestURI:
GET https://{api-gateway}/report-design-service/v1.0/report-file/delete?orgId=yourOrgId
#requestBody:
{
    "reportId": "ddaa91a6723c9d111758c1cf52b14d8f",
    "reportKey": "yourReportKey"，
    "originalId":"ddaa91a6723c9d111758c1cf52b14d8f"
}

Response Sample¶

{
    "msg": "OK",
    "code": 0,
    "data": true
}