5.10.2 api log subscribe

Funkce /api/log/subscribe vytvoří kanál pro odběr událostí (subscription) a vrací unikátní identifikátor, který se použije při následném volání funkcí /api/log/pull, příp. /api/log/unsubscribe. 

Každý kanál pro odběr událostí obsahuje vlastní frontu událostí. Do fronty kanálu jsou ukládány všechny nové události, které odpovídají filtru kanálu (parametr filter).  Události z fronty kanálu lze číst pomocí funkce /api/log/pull.

Současně zařízení udržují v interní paměti frontu historie událostí (posledních 10000 události). Po restartu zařízení je tato fronta historie vždy prázdná.

Pomocí parametru include lze specifikovat, zda fronta kanálu bude na počátku prázdná (tj. budou do ní zapsány pouze nové události, které vzniknou po vytvoření kanálu), příp. zda má být jednorázově naplněna událostmi z části nebo celé zaznamenané historie událostí.

Pomocí parametru duration lze specifikovat životnost kanálu v případě, že se k němu nepřistupuje pomocí funkce /api/log/pull. Po nastavené době bude nepoužívaný kanál automaticky uzavřen, jako by byla použita funkce /api/log/unsubscribe.

Funkce je součástí služby Logging a v případě použití autentizace je nutné pro některé události nastavit privilegia uživatele podle tabulky níže. Do fronty kanálu nebudou zařazovány události, pro které autentizovaný uživatel nemá požadovaná privilegia.

Tabulka událostí:

Pro tuto funkci lze použít metody GET nebo POST.

Parametry požadavku:

Odpověď je ve formátu application/json a obsahuje pouze identifikátor vytvořeného subscription.

Příklad:

GET /api/log/subscribe?filter=KeyPressed,InputChanged
{
  "success" : true,
  "result" : {
    "id" : 2121013117
  }
}