Regenerate an On-Call Pay Report

Triggers regeneration of an existing on-call pay report.

POST /v1/on_call_pay_reports/{id}/regenerate

Regenerate an On-Call Pay Report

cURL

curl --request POST \
  --url https://api.rootly.com/v1/on_call_pay_reports/{id}/regenerate \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.rootly.com/v1/on_call_pay_reports/{id}/regenerate"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.rootly.com/v1/on_call_pay_reports/{id}/regenerate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.rootly.com/v1/on_call_pay_reports/{id}/regenerate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.rootly.com/v1/on_call_pay_reports/{id}/regenerate"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.rootly.com/v1/on_call_pay_reports/{id}/regenerate")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.rootly.com/v1/on_call_pay_reports/{id}/regenerate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "data": {
    "id": "<string>",
    "type": "on_call_pay_reports",
    "attributes": {
      "start_date": "2023-12-25",
      "end_date": "2023-12-25",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "total_duration": 123,
      "users_count": 123,
      "currency": "<string>",
      "hourly_rate_cents": 123,
      "daily_rate_cents": 123,
      "total_pay_cents": 123,
      "include_shadow": true,
      "show_individual_shift_data": true,
      "has_single_rate": true,
      "enabled_granular_time_breakdown": true,
      "last_generated_at": "2023-11-07T05:31:56Z",
      "time_zone": "<string>",
      "use_responders_time_zone": true,
      "csv_file_url": "<string>",
      "xlsx_file_url": "<string>"
    }
  },
  "included": [
    {
      "id": "<string>",
      "type": "<string>",
      "attributes": {},
      "relationships": {}
    }
  ]
}

{
  "errors": [
    {
      "title": "<string>",
      "status": "<string>",
      "code": "<string>",
      "detail": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

Response

200

application/vnd.api+json

on_call_pay_report regeneration triggered

data · object · required

Show child attributes

included · object[]

Show child attributes