Trouble seeing the images? Right click on images and open in new tab to enlarge or zoom in on the page (Ctrl + mousewheel).

In this article we provide detail on the API call for deleting reports in WebReports.

Why Use the DeleteReports API Call?

The DeleteReports API call will allow users with the API role, or API key, to remove reports from WebReports. 

Example DeleteReports API call includes the following:

- DeleteReports (takes a list of string / report names)

API Prerequisites:

- Must have the API role in WebReports

- Established Connection/Cookie

Video Tutorial:

Not yet available.

Structure / Example of DeleteReports API Call

DeleteReports API Endpoint:

Delete Reports: /api/Service/DeleteReports

DeleteReports API Endpoint using the API Key Controller

/extapi/APIWebReport/DeleteReports

DeleteReports Parameter Structure:

When sending a call to DeleteReports, the controller is looking for a list of "string".

Delete Reports:

(Creating a List of string (report names) to send to the API)

Dim Reports As New List(Ofstring)

Reports.Add("Report1.vdm")

Reports.Add("Report2.vdm")

(Sending the List of string (report names) to the API Call)

Dim Params As StringContent = New StringContent(JsonConvert.SerializeObject(Roles, Formatting.Indented), Encoding.UTF8, "application/json")
Dim openResponse = client.PostAsync("server/api/Service/DeleteReports", Params).GetAwaiter().GetResult()