Schedule a saved report's e-mail

Reference

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

Adds e-mail slots to a saved report, as the console's schedule dialog does: the report runs at 'hour' (UTC) on each day listed in daysOfTheWeek and/or daysOfTheMonth and is mailed as 'format' to the caller and the report's recipients. A slot the report already has is left as it is. A JSON e-mail names its fields as the report's jsonKeys says.

Path Params

id integer required

Saved report id

42

Form Params

format string required

File format mailed

PDF

hour integer required

Hour of the day in UTC, 0-23

8

daysOfTheMonth array<integer>

Days of the month, 1-31

1

daysOfTheWeek array<string>

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

MONDAY

Responses

200

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

400

No day given, hour outside 0-23, a day of the month outside 1-31, or no format

401

Authentication error

403

Forbidden — insufficient permissions

404

No saved report of the caller has this id

Language

cURL Request

curl --request POST \
  --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 'format=PDF' \
  --data-urlencode 'hour=8' \
  --data-urlencode 'daysOfTheMonth=1' \
  --data-urlencode 'daysOfTheWeek=MONDAY'

Python Request

import requests

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

Node Request

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

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("POST", HttpRequest.BodyPublishers.ofString("format=PDF&hour=8&daysOfTheMonth=1&daysOfTheWeek=MONDAY"))
    .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("POST"), "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> { ["format"] = "PDF", ["hour"] = "8", ["daysOfTheMonth"] = "1", ["daysOfTheWeek"] = "MONDAY" });

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("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/saved-reports/42/schedule.do", strings.NewReader(`format=PDF&hour=8&daysOfTheMonth=1&daysOfTheWeek=MONDAY`))
	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, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY", "Content-Type: application/x-www-form-urlencoded"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'format=PDF&hour=8&daysOfTheMonth=1&daysOfTheWeek=MONDAY');

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::Post.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Content-Type'] = 'application/x-www-form-urlencoded'
request.set_form_data('format' => "PDF", 'hour' => "8", 'daysOfTheMonth' => "1", 'daysOfTheWeek' => "MONDAY")

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