Delete Report Template¶

Delete 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/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>>
reportKey	Query	Optional	String	The custom ID of the report template, specified by the caller. How to get reportKey>>
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>>
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).
If you intend to delete a specific version of the report template, use reportId. If you use reportKey or originalId in your request, all versions of the identified report template will be deleted.

Response Parameters¶

Name	Data Type	Description
data	Boolean	Indicates whether the deletion is completed. `true` means the report template is deleted, and `false` means the deletion failed.

Response Content Type¶

application/json

Response Codes¶

See Reporting Tool API Response Codes.

Samples¶

Request Sample¶

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

Response Sample¶

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