WFBSS :: Report :: delete | Trend Micro Service Central

Views:

Last Updated: 1/22/2020 12:11:13 AM

Delete scheduled reports for customers

Request

HTTP Request

DELETE /SMPI/{version}/service/wfbss/api/report

Parameters

Name	Type	Description	Validation
Required Parameters
cids	string	A list of customer IDs separated by comma.	At least one customer ID must be specified, and no more than 10.
Optional Parameters
name	string	Report name	Either one of name and rtid is required.
rtid	integer	Report ID	Either one of name and rtid is required.

HTTP Request Example

1. Delete the scheduled reports having the specified name
PUT /SMPI/{version}/service/wfbss/api/report?cids=74AE704D-CD9E-4F45-A62B-CA3AED65F99F&name=weekly report

2. Delete the scheduled report whose report ID is 1
PUT /SMPI/{version}/service/wfbss/api/report?cids=74AE704D-CD9E-4F45-A62B-CA3AED65F99F&rtid=1

Do not supply a request body with this method.

Response

If successful, this method returns an HTTP 200 OK status code and a response body with the following structure:

1. Response of the request to delete report for one customer
{
  "customers": [
    {
      "rtid": 2,
      "message": "",
      "id": "640FE47F-5118-4D79-8221-A35D0DE2EE2C",
      "result": "Done",
      "eid": "B2C79DCE-D642-4310-A984-F82DC9051E70"
    }
  ]
}

2. Response of the request to delete reports for multiple customers
{
  "customers": [
    {
      "rtid": 2,
      "message": "",
      "id": "640FE47F-5118-4D79-8221-A35D0DE2EE2C",
      "result": "Done",
      "eid": "B2C79DCE-D642-4310-A984-F82DC9051E70"
    },
    {
      "rtid": 1,
      "message": "",
      "id": "549390C2-61B3-417E-B1F0-8955A63C08F3",
      "result": "Done",
      "eid": "D8932A43-815C-4177-908C-4FE2C4BF5FF0"
    }
  ]
}

3. If you call the API to delete reports for multiple customers but some customer ID are invalid, the response will only contain the result for the valid Customers.

For example, call the API with two valid Customer ID 640FE47F-5118-4D79-8221-A35D0DE2EE2C and 549390C2-61B3-417E-B1F0-8955A63C08F3 but one invalid Customer ID XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX.
The response will contain the result for 640FE47F-5118-4D79-8221-A35D0DE2EE2C and 549390C2-61B3-417E-B1F0-8955A63C08F3.
{
  "customers": [
    {
      "rtid": 2,
      "message": "",
      "id": "640FE47F-5118-4D79-8221-A35D0DE2EE2C",
      "result": "Done",
      "eid": "B2C79DCE-D642-4310-A984-F82DC9051E70"
    },
    {
      "rtid": 1,
      "message": "",
      "id": "549390C2-61B3-417E-B1F0-8955A63C08F3",
      "result": "Done",
      "eid": "D8932A43-815C-4177-908C-4FE2C4BF5FF0"
    }
  ]
}

Name	Type	Description	Length
customers[].id	string	Customer ID	GUID
customers[].eid	string	For internal use	GUID
customers[].rtid	integer	Report ID of the deleted report
customers[].result	string	Result	Done = success; LimitError = over the report limit 10; SpecError = report template spec error; InternalError = other errors; Exception = unexpected exception
customers[].message	string	Error message	If customers[].result is “DONE”, it will be empty. If customers[].result is “LimitError”, it will be “over the report limit”. If customers[].result is “SpecError”, it will be “report template spec error”. Otherwise, it will show the detail error message of the unexpected exception or internal error.