Tento blok obsahuje metody pro práci s Reporty.
| Info |
|---|
Popis základních pojmů systému naleznete ZDE. |
| Info |
|---|
Base API URL: https://monitoring.creditcheck.cz |
| Info |
|---|
Veškeré dotazy z tohoto bloku očekávají autorizační Bearer Token v hlavičce requestu. Vybrané metody pak očekávají Body Requestu ve formátu JSON. |
GET/api/report/getreports
Vrací kolekci všech reportů dostupných v systému. Lze volat bez dalších parametrů pro získání kompletního přehledu všech Reportů.Alternativně lze volat s libovolnou kombinací parametrů:
maxCount => Limituje počet Reportů, které dotaz vrátí v odpovědi
fromDate => Filtruje pouze Reporty, které byly vygenerovány po zadaném datu
| Note |
|---|
Tato operace může trvat velmi dlouho v závislosti na množství přístupných Reportů v systému pro právě autentizovaného uživatele. |
| Info |
|---|
Reporty vrací ve výstupním formátu který byl nastaven jako preferovaný v době jejich generování. Pokud si přejete stáhnou Report v jiném formátu. Použijte metodu getreport s odpovídajícím id požadovaného reportu. |
Ukázky reportu
GET https://monitoring.creditcheck.cz/api/report/getreports
GET https://monitoring.creditcheck.cz/api/report/getreports?maxCount=1
GET https://monitoring.creditcheck.cz/api/report/getreports?fromDate=2000-12-11T12:16:10.163Z
GET/api/report/getreport
Vrací vybraný Report v požadovaném formátu.
Parametry:
id
format => použijte číselníkovou hodnotu získanou z metody: /api/report/getreporttypes
Ukázka requestu
https://monitoring.creditcheck.cz/api/report/getreport?id=02eb2061-bbe9-40f0-881b-a152d0351584&format=3
GET/api/report/getreporttypes
Vrací číselník formátů pro použití v metodě /api/report/getreport.