Delete Report Template¶

删除报表模板。

请求格式¶

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

请求参数 (URI)¶

名称	位置 (Path/Query)	必需/可选	数据类型	描述
orgId	Query	必需	String	报表模板所属组织的 ID。如何获取 orgID>>

请求参数 (Body)¶

名称

必需/可选

数据类型

描述

reportKey

可选

String

报表模板的密钥（key）。如何获取 reportKey>> 模板密钥需满足以下要求：

自定义模板的密钥需保证在当前 OU 中的唯一性。
标准模板的密钥需保证全局唯一，即在所有 OU 中唯一。

reportId

可选

String

报表的唯一 ID。如何获取 reportId>>

originalId

可选

String

上传报表后，接口返回的第一个 reportId。如何获取 originalId>>

指定报表模板的参数的优先级如下：

reportId（最高）> originalId > reportKey（最低）。

reportId、reportKey 和 originalId 均为可选参数，但在一次请求中必须使用至少其中一个参数。

reportId 参数用于删除单个任务，reportKey 或 originalId 参数可用于删除多个任务。

返回内容类型¶

application/json

返回码¶

参见报表工具 API 返回码。

示例¶

请求示例¶

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

返回示例¶

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