Rozdíly
Zde můžete vidět rozdíly mezi vybranou verzí a aktuální verzí dané stránky.
Obě strany předchozí revize Předchozí verze Následující verze | Předchozí verze Následující verze Obě strany příští revize | ||
cs:mervis-scada:50-api [2017/06/29 14:32] m.chlupac odstraněno |
cs:mervis-scada:50-api [2024/04/16 11:25] v.musilek [api/set/executeActions] |
||
---|---|---|---|
Řádek 1: | Řádek 1: | ||
====== API ====== | ====== API ====== | ||
- | Mervis SCADA nabízí otevřené REST API postavené na JSON a XML formátech dat. Pro kompletní popis API kontaktujte naši [[cs: | + | Mervis SCADA nabízí otevřené REST-like API postavené na JSON a XML formátech dat. Pro kompletní popis API kontaktujte naši [[cs: |
+ | |||
+ | ===== Přehled základních API metod ===== | ||
+ | |||
+ | ^Function^Description| | ||
+ | |||
+ | ^api/ | ||
+ | ^api/ | ||
+ | ^api/ | ||
+ | ^api/ | ||
+ | ^api/ | ||
+ | ^api/ | ||
+ | ^api/ | ||
+ | ^api/ | ||
+ | ^api/ | ||
+ | ^api/ | ||
+ | ^api/ | ||
+ | ^api/ | ||
+ | ^api/ | ||
+ | ^api/ | ||
+ | ^api/ | ||
+ | ^api/ | ||
+ | ^api/ | ||
+ | ^api/ | ||
+ | ^api/ | ||
+ | ^api/ | ||
+ | ^api/ | ||
+ | ^/ | ||
===== Příklad ===== | ===== Příklad ===== | ||
+ | ==== api/ | ||
+ | **Request** | ||
- | **Request: GetHistoryRequest** | + | * URL: https:// |
- | * URL: / | + | * Method: POST |
- | < | + | |
+ | |||
+ | <code javascript> | ||
+ | {" | ||
+ | </ | ||
+ | |||
+ | **Response** | ||
+ | |||
+ | <code xml> | ||
+ | <?xml version=" | ||
+ | < | ||
+ | </ | ||
+ | |||
+ | | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | ==== api/ | ||
+ | |||
+ | **Request** | ||
+ | |||
+ | * URL: / | ||
+ | * Method: POST | ||
+ | * Umožňuje stahovat historii pro více datových bodů | ||
+ | * V ukázkách je vždy za dvěma lomítky uvedený typ property | ||
+ | * V sekci credentials lze místo " | ||
+ | * " | ||
+ | * " | ||
+ | * položky " | ||
+ | |||
+ | |||
+ | <code javascript> | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | } | ||
+ | }, | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | } | ||
+ | } | ||
+ | ] | ||
+ | }, | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | }, | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | **Response** | ||
+ | |||
+ | * Dokud je v odpovědi v sekci " | ||
+ | * " | ||
+ | * Values | ||
+ | * v - hodnota | ||
+ | * ts - začátek platnosti hodnoty | ||
+ | * gt - konec platnosti hodnoty | ||
+ | * i - interval, pokud je jiný než uvedená hodnota u celé série | ||
+ | * Meta | ||
+ | * type - typ uložených hodnot - double, string, datetime | ||
+ | * unit - jednotky | ||
+ | * interval - informace o periodě, v jaké by měly být hodnoty v databázi uloženy. Slouží k identifikaci chybějících záznamů. | ||
+ | |||
+ | <code javascript> | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | }, | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | ] | ||
+ | }, | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | }, | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | ] | ||
+ | } | ||
+ | ] | ||
+ | }, | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | } | ||
+ | |||
+ | |||
+ | </ | ||
+ | |||
+ | **Funkční demo** | ||
+ | <code javascript> | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | } | ||
+ | }, | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | } | ||
+ | } | ||
+ | ] | ||
+ | }, | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | } | ||
+ | } | ||
+ | |||
+ | </ | ||
+ | |||
+ | |||
+ | |||
+ | ==== [Deprecated] api/ | ||
+ | |||
+ | **Request** | ||
+ | |||
+ | * URL: / | ||
+ | * Method: POST | ||
+ | |||
+ | < | ||
{ | { | ||
" | " | ||
- | "t":" | + | "n":" |
+ | " | ||
+ | " | ||
}, | }, | ||
- | " | + | " |
- | " | + | " |
- | " | + | " |
- | " | + | " |
- | " | + | |
" | " | ||
" | " | ||
Řádek 28: | Řádek 274: | ||
<code xml> | <code xml> | ||
+ | <?xml version=" | ||
< | < | ||
- | <hist projId=" | + | |
- | < | + | < |
- | < | + | < |
- | <hv ts="2017-05-08T22:26:53.32684Z" gt="2017-05-08T22:31:53.465467Z"> | + | <hv ts="2018-11-02T21:26:08.7936747Z" gt="2018-11-03T20:35:08.8060769Z"> |
- | < | + | < |
- | </ | + | </ |
- | <hv ts="2017-05-08T22:36:53.283875Z"> | + | <hv ts=" |
- | < | + | < |
- | </ | + | </ |
- | <hv ts="2017-05-08T22:41:53.435042Z"> | + | <hv ts="2018-11-05T11:40:04.0077949Z" |
- | < | + | < |
- | </ | + | </ |
- | <hv ts="2017-05-08T22:46:53.711496Z" gt="2017-05-08T23:36:53.776657Z"> | + | <hv ts=" |
- | < | + | < |
- | </ | + | </ |
- | + | <hv ts="2018-11-05T19:43: | |
- | </ | + | < |
- | </ | + | </ |
+ | <hv ts=" | ||
+ | < | ||
+ | </ | ||
+ | <hv ts="2018-11-06T02:40:03.61157Z" gt="2018-11-06T04:52:03.1759539Z"> | ||
+ | < | ||
+ | </ | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | <hv ts=" | ||
+ | < | ||
+ | </ | ||
+ | <hv ts=" | ||
+ | < | ||
+ | </ | ||
+ | <hv ts=" | ||
+ | < | ||
+ | </ | ||
+ | <hv ts=" | ||
+ | < | ||
+ | </hv> | ||
+ | </ | ||
+ | </ | ||
</ | </ | ||
+ | |||
</ | </ | ||
+ | |||
+ | |||
+ | ====api/ | ||
+ | |||
+ | **Request** | ||
+ | |||
+ | * URL: / | ||
+ | * Method: POST | ||
+ | * Content-Type: | ||
+ | |||
+ | Atribut **i** nastavuje **interval** ([[https:// | ||
+ | |||
+ | V **cred** lze použít i ověření pomocí jména a hesla, ale využití **tokenu** nabízí vyšší výkon. | ||
+ | |||
+ | Všechny časové údaje jsou očekávány v UTC. | ||
+ | |||
+ | <code xml> | ||
+ | <?xml version=" | ||
+ | < | ||
+ | xmlns: | ||
+ | xmlns: | ||
+ | projId=" | ||
+ | dpId=" | ||
+ | <n2:cred t=" | ||
+ | < | ||
+ | <hv ts=" | ||
+ | < | ||
+ | </hv> | ||
+ | <hv ts=" | ||
+ | < | ||
+ | </hv> | ||
+ | <hv ts=" | ||
+ | < | ||
+ | </hv> | ||
+ | <hv ts=" | ||
+ | < | ||
+ | </hv> | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | **Response** | ||
+ | |||
+ | * 200 OK | ||
+ | |||
+ | ====api/ | ||
+ | |||
+ | * URL: / | ||
+ | * Method: POST | ||
+ | * Content-Type: | ||
+ | |||
+ | ===DoubleValue=== | ||
+ | |||
+ | **Request** | ||
+ | |||
+ | <code xml> | ||
+ | <?xml version=" | ||
+ | < | ||
+ | xmlns: | ||
+ | xmlns: | ||
+ | xmlns: | ||
+ | <n1:cred t=" | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | </ | ||
+ | < | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | **Response** | ||
+ | |||
+ | <code xml><? | ||
+ | < | ||
+ | |||
+ | ===PlanningCalendar=== | ||
+ | |||
+ | * v requestu je atribut " | ||
+ | * pokud je kalendář číslený místo " | ||
+ | |||
+ | **Request** | ||
+ | |||
+ | <code xml> | ||
+ | <?xml version=" | ||
+ | < | ||
+ | xmlns: | ||
+ | xmlns: | ||
+ | <n1:cred t=" | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | <n2:ch cmd=" | ||
+ | <n2:def start=" | ||
+ | < | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | **Response** | ||
+ | |||
+ | <code xml><? | ||
+ | < | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | ====api/ | ||
+ | |||
+ | Nejvhodnější způsob vyčtení aktuálních hodnot datových bodů (property " | ||
+ | |||
+ | **Request** | ||
+ | |||
+ | * URL: / | ||
+ | * Method: POST | ||
+ | |||
+ | <code javascript> | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | ] | ||
+ | } | ||
+ | |||
+ | </ | ||
+ | |||
+ | **Response** | ||
+ | |||
+ | <code xml><? | ||
+ | <values xmlns: | ||
+ | < | ||
+ | <v projId=" | ||
+ | < | ||
+ | <d id=" | ||
+ | < | ||
+ | <p n=" | ||
+ | < | ||
+ | </p> | ||
+ | </ | ||
+ | </d> | ||
+ | <d id=" | ||
+ | < | ||
+ | <p n=" | ||
+ | < | ||
+ | </p> | ||
+ | </ | ||
+ | </d> | ||
+ | </ | ||
+ | </v> | ||
+ | </ | ||
+ | </ | ||
+ | |||