List
curl --request POST \
--url https://api.example.com/api/balances/indemnity-values.list \
--header 'Content-Type: application/json' \
--data '
{
"indemnity_ids": [
"872815618512410358"
],
"resource_ids": [
"872815618512410358"
],
"date_range": "2019-11-11/2019-12-12",
"team_ids": [
"872815618512410358"
]
}
'import requests
url = "https://api.example.com/api/balances/indemnity-values.list"
payload = {
"indemnity_ids": ["872815618512410358"],
"resource_ids": ["872815618512410358"],
"date_range": "2019-11-11/2019-12-12",
"team_ids": ["872815618512410358"]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
indemnity_ids: ['872815618512410358'],
resource_ids: ['872815618512410358'],
date_range: '2019-11-11/2019-12-12',
team_ids: ['872815618512410358']
})
};
fetch('https://api.example.com/api/balances/indemnity-values.list', 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.example.com/api/balances/indemnity-values.list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'indemnity_ids' => [
'872815618512410358'
],
'resource_ids' => [
'872815618512410358'
],
'date_range' => '2019-11-11/2019-12-12',
'team_ids' => [
'872815618512410358'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/balances/indemnity-values.list"
payload := strings.NewReader("{\n \"indemnity_ids\": [\n \"872815618512410358\"\n ],\n \"resource_ids\": [\n \"872815618512410358\"\n ],\n \"date_range\": \"2019-11-11/2019-12-12\",\n \"team_ids\": [\n \"872815618512410358\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
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.example.com/api/balances/indemnity-values.list")
.header("Content-Type", "application/json")
.body("{\n \"indemnity_ids\": [\n \"872815618512410358\"\n ],\n \"resource_ids\": [\n \"872815618512410358\"\n ],\n \"date_range\": \"2019-11-11/2019-12-12\",\n \"team_ids\": [\n \"872815618512410358\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/balances/indemnity-values.list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"indemnity_ids\": [\n \"872815618512410358\"\n ],\n \"resource_ids\": [\n \"872815618512410358\"\n ],\n \"date_range\": \"2019-11-11/2019-12-12\",\n \"team_ids\": [\n \"872815618512410358\"\n ]\n}"
response = http.request(request)
puts response.read_body[
{
"indemnity_id": "872815618512410358",
"resource_id": "872815618512410358",
"total": {
"value": 123,
"output_format": "days",
"error": "<string>"
},
"daily_values": [
{
"date": "2019-11-11",
"value": {
"value": 123,
"output_format": "days",
"error": "<string>"
}
}
]
}
]Indemnity values
List
Lists the indemnity values of resources over a date range, one entry per indemnity and resource it is computed for. The number of distinct resources multiplied by the number of days in the date range must not exceed 10,000, whatever the number of indemnities.
POST
/
api
/
balances
/
indemnity-values.list
List
curl --request POST \
--url https://api.example.com/api/balances/indemnity-values.list \
--header 'Content-Type: application/json' \
--data '
{
"indemnity_ids": [
"872815618512410358"
],
"resource_ids": [
"872815618512410358"
],
"date_range": "2019-11-11/2019-12-12",
"team_ids": [
"872815618512410358"
]
}
'import requests
url = "https://api.example.com/api/balances/indemnity-values.list"
payload = {
"indemnity_ids": ["872815618512410358"],
"resource_ids": ["872815618512410358"],
"date_range": "2019-11-11/2019-12-12",
"team_ids": ["872815618512410358"]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
indemnity_ids: ['872815618512410358'],
resource_ids: ['872815618512410358'],
date_range: '2019-11-11/2019-12-12',
team_ids: ['872815618512410358']
})
};
fetch('https://api.example.com/api/balances/indemnity-values.list', 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.example.com/api/balances/indemnity-values.list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'indemnity_ids' => [
'872815618512410358'
],
'resource_ids' => [
'872815618512410358'
],
'date_range' => '2019-11-11/2019-12-12',
'team_ids' => [
'872815618512410358'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/balances/indemnity-values.list"
payload := strings.NewReader("{\n \"indemnity_ids\": [\n \"872815618512410358\"\n ],\n \"resource_ids\": [\n \"872815618512410358\"\n ],\n \"date_range\": \"2019-11-11/2019-12-12\",\n \"team_ids\": [\n \"872815618512410358\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
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.example.com/api/balances/indemnity-values.list")
.header("Content-Type", "application/json")
.body("{\n \"indemnity_ids\": [\n \"872815618512410358\"\n ],\n \"resource_ids\": [\n \"872815618512410358\"\n ],\n \"date_range\": \"2019-11-11/2019-12-12\",\n \"team_ids\": [\n \"872815618512410358\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/balances/indemnity-values.list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"indemnity_ids\": [\n \"872815618512410358\"\n ],\n \"resource_ids\": [\n \"872815618512410358\"\n ],\n \"date_range\": \"2019-11-11/2019-12-12\",\n \"team_ids\": [\n \"872815618512410358\"\n ]\n}"
response = http.request(request)
puts response.read_body[
{
"indemnity_id": "872815618512410358",
"resource_id": "872815618512410358",
"total": {
"value": 123,
"output_format": "days",
"error": "<string>"
},
"daily_values": [
{
"date": "2019-11-11",
"value": {
"value": 123,
"output_format": "days",
"error": "<string>"
}
}
]
}
]This endpoint is in preview: it may change without notice until it becomes part of a stable version.
Body
application/json
Defaults to, and is limited to, every team the caller can view the indemnities of. The indemnities and resources outside these teams are left out, but the values count every team of the indemnity, even on an instance that scopes indemnities by team in the indemnity report.
Response
200 - application/json