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 | ||
cs:mervis-scada:50-api [2018/11/02 07:32] m.chlupac |
cs:mervis-scada:50-api [2021/04/15 10:34] (aktuální) m.chlupac [api/checkCredentials] |
||
---|---|---|---|
Řádek 28: | Řádek 28: | ||
^api/ | ^api/ | ||
^api/ | ^api/ | ||
+ | ^/ | ||
===== Příklad ===== | ===== Příklad ===== | ||
- | ====api/get/history==== | + | ==== api/checkCredentials |
**Request** | **Request** | ||
- | * URL: /api/get/history?format=xml | + | * URL: https://scada.mervis.info/ |
* Method: POST | * Method: POST | ||
- | <code json> | + | |
+ | < | ||
+ | {" | ||
+ | </ | ||
+ | |||
+ | **Response** | ||
+ | |||
+ | <code xml> | ||
+ | <?xml version=" | ||
+ | < | ||
+ | </ | ||
+ | |||
+ | * Získaný token **t** je třeba použít místo dvojice jméno/ | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | ==== 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> | ||
{ | { | ||
- | " | + | " |
- | "t":" | + | " |
+ | }, | ||
+ | " | ||
+ | "commonSeriesParameters": | ||
+ | "from": "2018-12-01T00: | ||
+ | " | ||
+ | }, | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | } | ||
+ | }, | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | } | ||
+ | } | ||
+ | ] | ||
+ | }, | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | }, | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | **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 | ||
+ | |||
+ | <code javascript> | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
}, | }, | ||
- | " | + | " |
- | " | + | " |
- | " | + | " |
- | " | + | " |
- | " | + | |
" | " | ||
" | " | ||
Řádek 58: | Řádek 274: | ||
<code xml> | <code xml> | ||
+ | <?xml version=" | ||
< | < | ||
- | <hist projId=" | + | <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> | </hv> | ||
- | <hv ts="2017-05-08T22:36:53.283875Z"> | + | <hv ts="2018-11-03T20:41:09.0100479Z" |
- | < | + | < |
</hv> | </hv> | ||
- | <hv ts="2017-05-08T22:41:53.435042Z"> | + | <hv ts="2018-11-05T11:40:04.0077949Z" |
- | < | + | < |
</hv> | </hv> | ||
- | <hv ts="2017-05-08T22:46:53.711496Z" gt="2017-05-08T23:36:53.776657Z"> | + | <hv ts="2018-11-05T17:28:03.4133447Z" gt="2018-11-05T19:40:03.0246122Z"> |
- | < | + | < |
+ | </ | ||
+ | <hv ts=" | ||
+ | < | ||
+ | </ | ||
+ | <hv ts=" | ||
+ | < | ||
+ | </ | ||
+ | <hv ts=" | ||
+ | < | ||
+ | </ | ||
+ | <hv ts=" | ||
+ | < | ||
+ | </ | ||
+ | <hv ts=" | ||
+ | < | ||
+ | </ | ||
+ | <hv ts=" | ||
+ | < | ||
+ | </ | ||
+ | <hv ts=" | ||
+ | < | ||
+ | </ | ||
+ | <hv ts=" | ||
+ | < | ||
</hv> | </hv> | ||
- | |||
</ | </ | ||
</ | </ | ||
Řádek 82: | Řádek 322: | ||
</ | </ | ||
- | ====api/v2/get/ | + | |
+ | ====api/set/ | ||
**Request** | **Request** | ||
- | * URL: /api/v2/get/ | + | * URL: /api/set/ |
* Method: POST | * Method: POST | ||
+ | * Content-Type: | ||
- | < | + | Atribut **i** nastavuje **interval** ([[https:// |
- | { | + | |
- | "data":{ | + | V **cred** lze použít i ověření pomocí jména a hesla, ale využití **tokenu** nabízí vyšší výkon. |
- | | + | |
- | "n":" | + | Všechny časové údaje jsou očekávány v UTC. |
- | " | + | |
- | "pe":0 | + | < |
- | }, | + | <?xml version="1.0" |
- | | + | < |
- | "from":" | + | xmlns:n2="http://dev.rcware.eu/ |
- | " | + | xmlns:n1="http:// |
- | | + | projId=" |
- | " | + | dpId="e86dba6d-1250-4e7f-aafb-84fd28324710"> |
- | " | + | <n2:cred t="xxxxx"/><!-- token should be used here --> |
- | | + | < |
- | | + | <hv ts="2020-03-15T11:00:00+00:00" |
- | { | + | |
- | "m_Item1":" | + | </hv> |
- | | + | < |
- | }, | + | |
- | | + | </ |
- | | + | < |
- | | + | <n1:v> |
- | } | + | </hv> |
- | ] | + | < |
- | } | + | <n1:v> |
- | } | + | </hv> |
- | </ | + | </ |
+ | </ | ||
**Response** | **Response** | ||
+ | |||
+ | * 200 OK | ||
+ | |||
+ | ====api/ | ||
+ | |||
+ | **Request** | ||
+ | |||
+ | * URL: / | ||
+ | * Method: POST | ||
+ | * Content-Type: | ||
<code xml> | <code xml> | ||
- | <?xml version=" | + | <?xml version=" |
- | <globalResponse | + | <executeActionsRequest |
- | <result code=" | + | xmlns: |
- | | + | xmlns:n1=" |
- | <n1: | + | xmlns:r=" |
- | < | + | <n1:cred t="xxxxx"/> <!-- token --> |
- | <n1: | + | <actionDefs projId="5abf8ca0-94ba-48df-8d3c-7ebe87a12fd0"> |
- | <n2:pl> | + | <actions> |
- | <n2:p n="Output" | + | <actionDefItem propName="INIT" |
- | <n3:hist projId="5abf8ca0-94ba-48df-8d3c-7ebe87a12fd0" | + | <execParam r:type="495c9644-eed1-4b94-933b-3fae702a9aca"> |
- | <n3:errMsg></n3:errMsg> | + | <n2:value>16</n2:value> |
- | <n3:vals> | + | </execParam> |
- | <n3:hv ts="2018-10-23T16: | + | </ |
- | < | + | < |
- | </n3:hv> | + | </actionDefItem> |
- | </n3:vals> | + | </actions> |
- | </n3:hist> | + | </actionDefs> |
- | | + | </executeActionsRequest></code> |
- | <n2:p n="Output" | + | |
- | <n3:hist projId="5abf8ca0-94ba-48df-8d3c-7ebe87a12fd0" | + | **Response** |
- | < | + | |
- | <n3:vals> | + | <code xml><? |
- | < | + | <executeActionsResponse xmlns:r="http:// |
- | < | + | |
- | </n3:hv> | + | ====api/ |
- | </ | + | |
- | </ | + | Nejvhodnější způsob vyčtení aktuálních hodnot datových bodů (property |
- | </ | + | |
- | </ | + | **Request** |
- | </ | + | |
- | </ | + | * URL: /api/ |
- | </ | + | * Method: POST |
- | </ | + | |
- | </ | + | <code javascript> |
+ | { | ||
+ | " | ||
+ | | ||
+ | }, | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | ] | ||
+ | } | ||
</ | </ | ||
+ | |||
+ | **Response** | ||
+ | |||
+ | <code xml><? | ||
+ | <values xmlns: | ||
+ | < | ||
+ | <v projId=" | ||
+ | < | ||
+ | <d id=" | ||
+ | < | ||
+ | <p n=" | ||
+ | < | ||
+ | </p> | ||
+ | </ | ||
+ | </d> | ||
+ | <d id=" | ||
+ | < | ||
+ | <p n=" | ||
+ | < | ||
+ | </p> | ||
+ | </ | ||
+ | </d> | ||
+ | </ | ||
+ | </v> | ||
+ | </ | ||
+ | </ | ||
+ | |||