curl --request GET \
--url https://api.engrate.io/schedule-management/v1/schedule-versions/{version_uid}/reports \
--header 'Authorization: <api-key>'import requests
url = "https://api.engrate.io/schedule-management/v1/schedule-versions/{version_uid}/reports"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.engrate.io/schedule-management/v1/schedule-versions/{version_uid}/reports', 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.engrate.io/schedule-management/v1/schedule-versions/{version_uid}/reports",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$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.engrate.io/schedule-management/v1/schedule-versions/{version_uid}/reports"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.engrate.io/schedule-management/v1/schedule-versions/{version_uid}/reports")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.engrate.io/schedule-management/v1/schedule-versions/{version_uid}/reports")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"items": [
{
"completeness": "partial",
"default_verdict": {
"confirmation": {
"finality": "intermediate",
"positions": [
{
"fault_tolerant_acceptance": true,
"kind": "confirmed",
"matching_rule": "lower_value",
"position": 123,
"set_manually": true,
"value": 123
}
],
"kind": "values"
},
"fault_tolerant_acceptance": {
"positions": [
123
]
},
"findings": {
"positions": [
{
"counterparty": 123,
"ours": 123,
"position": 123
}
],
"reasons": [
{
"code": "<string>",
"text": "<string>"
}
]
},
"match_status": "matched",
"refusal": {
"reasons": [
{
"code": "<string>",
"text": "<string>"
}
]
}
},
"incoming_message_id": "<string>",
"kind": "anomaly_report",
"match_report_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"observed_at": "2023-11-07T05:31:56Z",
"scheduling_area_responsible": "<string>",
"stated_at": "2023-11-07T05:31:56Z",
"verdicts": [
{
"series": {
"direction": "production",
"scheduling_area": "<string>",
"type": "production_consumption"
},
"verdict": {
"confirmation": {
"finality": "intermediate",
"positions": [
{
"fault_tolerant_acceptance": true,
"kind": "confirmed",
"matching_rule": "lower_value",
"position": 123,
"set_manually": true,
"value": 123
}
],
"kind": "values"
},
"fault_tolerant_acceptance": {
"positions": [
123
]
},
"findings": {
"positions": [
{
"counterparty": 123,
"ours": 123,
"position": 123
}
],
"reasons": [
{
"code": "<string>",
"text": "<string>"
}
]
},
"match_status": "matched",
"refusal": {
"reasons": [
{
"code": "<string>",
"text": "<string>"
}
]
}
}
}
],
"version": 123
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}List Match Reports
Get the match reports for one schedule version, in the sequence of stated_at, from first to last.
A match report contains the information that the Scheduling Area Responsible gave about the version in one market message. The market message is an anomaly report, a confirmation report or an acknowledgement. A match report gives a verdict on each series in verdicts.
Some match reports give a verdict on series that are not in verdicts. Such a report is complete. Its default_verdict is the verdict on each series of the version that is not in verdicts. For example, a report can show only the series with a problem, and give matched to all other series.
A complete report also gives default_verdict to each series that a previous report on the version identified, for example a series that only the counterparty sent.
-
404 if no schedule version of your organization has this uid.
-
422 if the uid is not a UUID.
curl --request GET \
--url https://api.engrate.io/schedule-management/v1/schedule-versions/{version_uid}/reports \
--header 'Authorization: <api-key>'import requests
url = "https://api.engrate.io/schedule-management/v1/schedule-versions/{version_uid}/reports"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.engrate.io/schedule-management/v1/schedule-versions/{version_uid}/reports', 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.engrate.io/schedule-management/v1/schedule-versions/{version_uid}/reports",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$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.engrate.io/schedule-management/v1/schedule-versions/{version_uid}/reports"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.engrate.io/schedule-management/v1/schedule-versions/{version_uid}/reports")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.engrate.io/schedule-management/v1/schedule-versions/{version_uid}/reports")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"items": [
{
"completeness": "partial",
"default_verdict": {
"confirmation": {
"finality": "intermediate",
"positions": [
{
"fault_tolerant_acceptance": true,
"kind": "confirmed",
"matching_rule": "lower_value",
"position": 123,
"set_manually": true,
"value": 123
}
],
"kind": "values"
},
"fault_tolerant_acceptance": {
"positions": [
123
]
},
"findings": {
"positions": [
{
"counterparty": 123,
"ours": 123,
"position": 123
}
],
"reasons": [
{
"code": "<string>",
"text": "<string>"
}
]
},
"match_status": "matched",
"refusal": {
"reasons": [
{
"code": "<string>",
"text": "<string>"
}
]
}
},
"incoming_message_id": "<string>",
"kind": "anomaly_report",
"match_report_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"observed_at": "2023-11-07T05:31:56Z",
"scheduling_area_responsible": "<string>",
"stated_at": "2023-11-07T05:31:56Z",
"verdicts": [
{
"series": {
"direction": "production",
"scheduling_area": "<string>",
"type": "production_consumption"
},
"verdict": {
"confirmation": {
"finality": "intermediate",
"positions": [
{
"fault_tolerant_acceptance": true,
"kind": "confirmed",
"matching_rule": "lower_value",
"position": 123,
"set_manually": true,
"value": 123
}
],
"kind": "values"
},
"fault_tolerant_acceptance": {
"positions": [
123
]
},
"findings": {
"positions": [
{
"counterparty": 123,
"ours": 123,
"position": 123
}
],
"reasons": [
{
"code": "<string>",
"text": "<string>"
}
]
},
"match_status": "matched",
"refusal": {
"reasons": [
{
"code": "<string>",
"text": "<string>"
}
]
}
}
}
],
"version": 123
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}Was this page helpful?