5.19.1 api automation trigger

Skupiny služeb a privilegií

  • Skupina služeb je Automation API.
  • Skupina privilegií je Access to Automation.

Metody

  • GET
  • POST

Požadavek
Požadavek obsahuje parametry ve formátu URL.

Tabulka 1. URL parametry požadavku

Název parametruPovinnýOčekávané hodnotyVýchozí hodnotaPopis
triggerIdAnoŘetězec (uživatelsky definovaný v Automation)-určuje, který block HttpTrigger bude aktivní


Příklad požadavku

URL:
https://192.168.1.1/api/automation/trigger?triggerId=triggerName

Odpověď
Odpověď je ve formátu application/json.

Tabulka 2. Klíče odpovědi JSON

KlíčTypické vrácené hodnotyPopis
successtrue, false

Když je požadavek úspěšně zpracován, je hodnota true (tj. blokování přístupu je v požadovaném stavu bez ohledu na změnu).

Example of a Response

{
    "success": true
}

Může dojít k různým chybám (např. chybějící povinný parametr). Není-li nalezen zadaný trigger ID (tj. neexistuje block s tímto názvem), zařízení odpoví chybovým kódem 12 s popisem "Trigger not found".