Tento blok obsahuje metody pro práci s objekty typu Monitoring.
| 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/monitoring
Vrací všechny Monitoringy ke kterým má uživatel s platným Tokenem přístup.
Ukázka requestu
GET https://monitoring.creditcheck.cz/api/monitoring
POST/api/monitoring
Zakládá nový Monitoring jehož vlastníkem se stane uživatel, který se identifikuje pomocí Tokenu.
Ukázka BODY requestu
| Code Block | ||
|---|---|---|
| ||
{
"name": "Test monitoring created through API - with filtration",
"datasets": [
"2dddded6-b74c-4978-a1b9-9f64f2793e2c"
],
"outputFormat": {
"online": 1,
"changes": 3,
"summary": 4
},
"emailRecipients": null,
"eventTypes": [
{
"id": 10001,
"frequency": 1,
"filtrationTree": {
"treeRoots": [
{
"id": 1,
"values": [
"2",
"3"
]
},
{
"id": 4,
"values": [
"CC_001_ISIR_0_0",
"CC_002_ISIR_0_0",
"CC_003_ISIR_0_0",
"CC_004_ISIR_0_0"
]
}
]
}
}
]
} |
DELETE/api/monitoring
Odstraní ze systému Monitoring s odpovídajícím ID.
| Info |
|---|
Očekává na vstupu Query parameter id. |
Ukázka requestu
DELETE https://monitoring.creditcheck.cz/api/monitoring?id=46805649-e4bb-5b62-af48-5047057ca128
GET/api/monitoring/{id}
Vrací informace o jednom konkrétním Monitoringu identifikovaném pomocí ID.
Ukázka requestu
GET https://monitoring.creditcheck.cz/api/monitoring/46805649-e4bb-5b62-af48-5047057ca128
PUT/api/monitoring/edit
Edituje existující Monitoring.
Edituje pouze klíče uvedené v BODY. Chybějící klíče kterými Monitoring disponuje a nejsou uvedeny v BODY nebudou editovány.
| Info |
|---|
Pro kompletní editaci celého Monitoringu doporučujeme nejprve získat aktuální stav pomocí GET metody. A následně provést změny v získaném výstupu a ten poslat zpět do systému v těle metody EDIT. |
| Note |
|---|
Klíč id je povinný. |
Ukázka
| Code Block | ||
|---|---|---|
| ||
{
"id": "eccc5560-f02f-44f6-aea6-91bf60466068",
"name": "Test monitoring created through API - with filtration (After edit)",
"datasets": [
"456b8d17-fd33-40c2-bfc2-3e43e30dd9d6"
],
"outputFormat": {
"online": 2,
"changes": 2,
"summary": 2
},
"emailRecipients": [
"m.janecek@creditcheck.cz",
"h.skubanek@creditcheck.cz"
],
"eventTypes": [
{
"id": 10001,
"frequency": 4,
"filtrationTree": {
"treeRoots": [
{
"id": 1,
"values": [
"5"
]
},
{
"id": 4,
"values": [
"CC_001_ISIR_0_0",
"CC_002_ISIR_0_0",
"CC_003_ISIR_0_0",
"CC_004_ISIR_0_0"
]
}
]
}
}
],
"isDeactivated": false
} |