Skip to content
grabarczyk-t edited this page Jun 1, 2014 · 40 revisions

###Wstęp API przygotowanego projektu opiera się o powszechnie stosowane praktyki REST'owe. Statusy wiadomości HTTP zwracane w podstawowych przypadkach są zgodne z przyjętymi standardami. Więcej na temat standardów można doczytać na stronie: http://www.restapitutorial.com/lessons/httpmethods.html.

Autoryzacja i uwierzytelnianie opiera się o BASIC.

Jako standard formatowania wiadomości wykorzystywany jest JSON + HAL.

#####Odpowiedzi serwera w przypadku sytuacji wyjątkowej

Jeżeli nie wszystkie maszyny są aktywne serwer zwróci błąd HTTP 503 Service Unavailable

W niektórych sytuacjach istnieje potrzeba przesłania dodatkowych informacji na temat przyczyny błędu logiki biznesowej. Informację te są zawarte w prezentowanej niżej strukturze.

Status HTTP: 500 Internal Server Error

{
"message":"Nie można usunąć pomiaru złożonego, ponieważ jest on wykorzystywany w systemie przez inny pomiar"
}

###Katalog

id zasób opis
[[RST_KT_MSL REST-API-Katalog#rst_kt_msl]] GET measurements
[[RST_KT_MSA REST-API-Katalog#rst_kt_msa]] POST measurements
[[RST_KT_MSD REST-API-Katalog#rst_kt_msd]] DELETE measurements/{id}
[[RST_KT_RSL REST-API-Katalog#rst_kt_rsl]] GET resources

###Monitor

id zasób opis
[[RST_MT_MSL REST-API-Monitor#rst_mt_msl]] GET measurements
[[RST_MT_CMSO REST-API-Monitor#rst_mt_cmso]] GET complex/types
[[RST_MT_CMSA REST-API-Monitor#rst_mt_cmsa]] POST measurements
[[RST_MT_MSG REST-API-Monitor#rst_mt_msg]] GET measurements/{id}
[[RST_MT_MSVL REST-API-Monitor#rst_mt_msvl]] GET measurements/{id}/data
[[RST_MT_CPLX REST-API-Monitor#rst_mt_cplx]] GET complex/{id}
[[RST_MT_CMSD REST-API-Monitor#rst_mt_cmsd]] DELETE measurements/{id}
[[RST_MT_RSL REST-API-Monitor#rst_mt_rsl]] GET resources

Clone this wiki locally