5.5.1 api io caps

Funkce /api/io/caps vrací seznam dostupných hardwarových vstupů a výstupů zařízení (portů). Funkce má volitelný parametr port, který určuje vstup/výstup, jehož vlastnosti se mají vrátit. Pokud parametr port není uveden, funkce vrací seznam všech vstupů a vstupů.

Funkce je součástí služby I/O a v případě použití autentizace je nutné, aby uživatel měl přiřazené privilegium Vstupy a výstupy – sledování. 

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

Parametry požadavku:

Odpověď je ve formátu application/json a obsahuje seznam portů (pole ports) a jejich aktuální nastavení. V případě použití parametru port obsahuje pole ports právě jednu položku.

Příklad:

GET /api/io/caps
{
  "success" : true,
  "result" : {
    "ports" : [
      {
        "port" : "relay1",
        "type" : "output"
      },
      {
        "port" : "relay2",
        "type" : "output"
      }
   ]
  }
}