Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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/dataset

Vrací informace o všech Datasetech pro uživatele, který se identifikuje pomocí Tokenu.

...

Ukázka BODY requestu

Code Block
languagejson
{
    "name": "Můj nový testovací dataset založený přes APIMůj nový dataset",
    "typeId": 1,
    "domainId": "2dabcb3e-b7a7-47a3-86d0-f64bcac8a756",
    "sharedUsersLogins": [
        "client_MJm.janecek@creditcheck.cz"
    ],
    "subjectIdentifiers": [
        "12345678",
        "65498721"
    ]
}

DELETE/api/dataset

Odstraní ze systému Dataset s odpovídajícím ID.

Info

Očekává na vstupu Query parameter id.

Ukázka requestu

DELETE https://monitoring.creditcheck.cz/api/dataset?id=03605649-e4bb-5b62-af48-5047057ca000

GET/api/dataset/{id}

Vrací informace o jednom konkrétním Datasetu identifikovaném pomocí ID.

Ukázka requestu

GET https://monitoring.creditcheck.cz/api/dataset/2dddded6-b74c-4978-a1b9-9f64f2793e2c

PUT/api/dataset/edit

Edituje existující Dataset. Aktuální konfiguraci Datasetu kompletně přepíše na základě tohoto Requestu.

Doporučené použití je získat aktuální stav Datasetu metodou GET. Zkopírovat si BODY z Response a provést v něm potřebné změny. Vzniklý JSON pak předhodit jako BODY této metodě.

Ukázka BODY requestu

Code Block
{
  "id": "2dddded6-b74c-4978-a1b9-9f64f2793e2c",
  "name": "Můj nový seznam subjektů - MJ (zeditovaný skrze API po třetí)",
  "ownerId": "9a4d9c52-299d-4e42-b1ec-3a2095fe2aeb",
  "sharedUsers": [
        "053b1b62-608a-4ffb-853c-7be6a4387101",
        "9a76890e-795c-4ed5-97f9-cd1f5c576652"
    ]
}