Remove a saved report's e-mail slots

Removes e-mail slots from a saved report, as the console's schedule dialog does.

Reference

DELETE https://YOUR-NETWORK-DOMAIN/rest-api/saved-reports/{id}/schedule.do

Removes e-mail slots from a saved report, as the console's schedule dialog does. With daysOfTheWeek and/or daysOfTheMonth and 'hour', only those slots go, whatever their format. With no day, every slot goes and the report is no longer mailed.

Path Params

id integer required

Saved report id

42

Form Params

daysOfTheMonth array<integer>

Days of the month, 1-31

1

daysOfTheWeek array<string>

Days of the week, e.g. MONDAY,FRIDAY

MONDAY

format string

File format mailed; required when adding slots

PDF

hour integer

Hour of the day in UTC, 0-23; required when adding slots, and when removing given days

8

Responses

200

The saved report with its schedule, in the shape of the GET

400

Days given without an hour, hour outside 0-23 or a day of the month outside 1-31

401

Authentication error

403

Forbidden — insufficient permissions

404

No saved report of the caller has this id, or none of the slots sent is scheduled

Language

cURL Request

curl --request DELETE \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/saved-reports/42/schedule.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'daysOfTheMonth=1' \
  --data-urlencode 'daysOfTheWeek=MONDAY' \
  --data-urlencode 'format=PDF'

Python Request

import requests

response = requests.request("DELETE", "https://YOUR-NETWORK-DOMAIN/rest-api/saved-reports/42/schedule.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"daysOfTheMonth": "1", "daysOfTheWeek": "MONDAY", "format": "PDF"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/saved-reports/42/schedule.do', {
  method: 'DELETE',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"daysOfTheMonth":"1","daysOfTheWeek":"MONDAY","format":"PDF"}),
});

console.log(await response.json());

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/saved-reports/42/schedule.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("DELETE", HttpRequest.BodyPublishers.ofString("daysOfTheMonth=1&daysOfTheWeek=MONDAY&format=PDF"))
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

C# Request

using var client = new HttpClient();

var request = new HttpRequestMessage(new HttpMethod("DELETE"), "https://YOUR-NETWORK-DOMAIN/rest-api/saved-reports/42/schedule.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["daysOfTheMonth"] = "1", ["daysOfTheWeek"] = "MONDAY", ["format"] = "PDF" });

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Go Request

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	req, _ := http.NewRequest("DELETE", "https://YOUR-NETWORK-DOMAIN/rest-api/saved-reports/42/schedule.do", strings.NewReader(`daysOfTheMonth=1&daysOfTheWeek=MONDAY&format=PDF`))
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")
	req.Header.Set("Content-Type", "application/x-www-form-urlencoded")

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()

	out, _ := io.ReadAll(res.Body)
	fmt.Println(string(out))
}

PHP Request

<?php
$ch = curl_init("https://YOUR-NETWORK-DOMAIN/rest-api/saved-reports/42/schedule.do");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY", "Content-Type: application/x-www-form-urlencoded"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'daysOfTheMonth=1&daysOfTheWeek=MONDAY&format=PDF');

echo curl_exec($ch);
curl_close($ch);

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/saved-reports/42/schedule.do")
request = Net::HTTP::Delete.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Content-Type'] = 'application/x-www-form-urlencoded'
request.set_form_data('daysOfTheMonth' => "1", 'daysOfTheWeek' => "MONDAY", 'format' => "PDF")

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.body