Rozdíly

Zde můžete vidět rozdíly mezi vybranou verzí a aktuální verzí dané stránky.

Odkaz na výstup diff

Obě strany předchozí revize Předchozí verze
Následující verze 		Předchozí verze
cs:mervis-scada:50-api [2021/04/06 10:30]
l.osladil [api/v3/get/history] 		cs:mervis-scada:50-api [2024/04/16 11:34] (aktuální)
v.musilek [api/get/values]
Řádek 33: Řádek 33:
 ===== Příklad ===== ===== Příklad =====
  
-====api/checkCredentials====+==== api/checkCredentials ====
  
 **Request** **Request**
Řádek 40: Řádek 40:
    * Method: POST    * Method: POST
  
-**Request** 
  
 <code javascript> <code javascript>
Řádek 53: Řádek 52:
 </code> </code>
  
-  * Získaný token **t** lze použít místo dvojice jméno/heslo v následujících API voláních.+  * Získaný token **t** je třeba použít místo dvojice jméno/heslo v následujících API voláních. 
 + 
 + 
 + 
  
-====api/v3/get/history====+==== api/v3/get/history ====
  
 **Request** **Request**
Řádek 61: Řádek 64:
    * URL: /api/v3/get/history?format=json    * URL: /api/v3/get/history?format=json
    * Method: POST    * 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 ukázkách je vždy za dvěma lomítky uvedený typ property
-   * V sekci credentials lze místo "token" uvest “name” a “password” s loginem a heslem uživatele, ale je určeno** jen pro testování** +   * V sekci credentials lze místo "token" uvést "name" a "password" - použití bez tokenu je ale výkonnostně penalizováno 
-   * “seriesParameters” - se uvádí jen pokud chceme rozdílné hodnoty jak v “commonSeriesParameters” +   * "seriesParameters" - se uvádí jen pokud chceme rozdílné hodnoty než v "commonSeriesParameters" 
-   * “clientReference” - slouží jen pro dodatečnou identifikaci DP pro klienta +   * "clientReference" - volitelné - pro dodatečnou identifikaci datového bodu klientem 
-   * v sekci “provider” se properta “id” nemusí zadávat +   * položky "segmenation", "requestState" a "serverState" se vyplňují podle poslední odpovědi serveru. Pro první volání se tyto hodnoty neuvádějí.
-   * sekce “segmenation” s “requestState” a “serverState” se vyplňují podle poslední odpovědi k dané historii a jsou nutné pro správné fungování(offsety atd). Tj. pro první volání se tyto hodnoty neuvádějí.+
  
  
Řádek 87: Řádek 90:
                 "clientReference": "myId2a", //string                 "clientReference": "myId2a", //string
                 "provider": {                 "provider": {
-                    "id": "689E32FA-24A2-448E-9374-6158E6E6CB15", //guid (optional property) 
                     "parameters": {                     "parameters": {
                         "projectId": "5abf8ca0-94ba-48df-8d3c-7ebe87a12fd0", //guid                         "projectId": "5abf8ca0-94ba-48df-8d3c-7ebe87a12fd0", //guid
Řádek 119: Řádek 121:
 **Response** **Response**
  
-   * Dokud je v response v sekci “segmentation” uveden “requestState” existují v daném rozsahu další historie. +   * Dokud je v odpovědi v sekci "segmentation" uveden "requestState" existují v daném rozsahu další historie. 
-   * “requestState” a “serverState” je nutné do dalšího případného dotazu na historii předat. +   * "requestState" a "serverState" je nutné do dalšího případného dotazu na historii předat. 
-   * Ve values se může objevit properta “i” která značí interval pro danou hodnotu. +   * Values 
-   * Hodnota historie(properta “v”) může být více druhů(typů).  Lze určit podle “meta.type”. Zatím se podporují tři(double, string, dateTime) tj. (double,string, datetime)+     * 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> <code javascript>
Řádek 235: Řádek 244:
  
 </code> </code>
-====api/get/history====+ 
 + 
 + 
 +==== [Deprecated] api/get/history====
  
 **Request** **Request**
Řádek 354: Řádek 366:
  
 ====api/set/executeActions==== ====api/set/executeActions====
- 
-**Request** 
  
    * URL: /api/set/executeActions?format=xml    * URL: /api/set/executeActions?format=xml
    * Method: POST    * Method: POST
    * Content-Type: text/xml    * Content-Type: text/xml
 +
 +===DoubleValue===
 +
 +**Request**
  
 <code xml> <code xml>
Řádek 386: Řádek 400:
 <executeActionsResponse xmlns:r="http://dev.rcware.eu/serialization/references" code="Ok" message="OK" xmlns="http://dev.rcware.eu/scada/error-reporting" /></code> <executeActionsResponse xmlns:r="http://dev.rcware.eu/serialization/references" code="Ok" message="OK" xmlns="http://dev.rcware.eu/scada/error-reporting" /></code>
  
-====api/get/values====+===PlanningCalendar===
  
-Nejvhodnější způsob vyčtení aktuálních hodnot datových bodů (property "Output") z jednoho nebo více projektů.+   * v requestu je atribut "val" který odkazuje na index items v definici plánovacího kalendáře 
 +   * pokud je kalendář číslený místo "val" se musí použít "dval" pro double hodnoty a "ival" pro integer hodnoty
  
 **Request** **Request**
 +
 +<code xml>
 +<?xml version="1.0" encoding="UTF-8"?>
 +<executeActionsRequest xmlns="http://dev.rcware.eu/scada/action-defs" 
 +xmlns:n1="http://dev.rcware.eu/auth" 
 +xmlns:r="http://dev.rcware.eu/serialization/references">
 +  <n1:cred t="xxxxx"/> <!-- token -->
 +  <actionDefs projId="17d3ff08-40c1-41c0-ad6a-bad4489323c7">
 +    <actions>
 +      <actionDefItem propName="SET" dpId="396bcab1-1973-4dd9-91a9-284cdced00fb">
 +        <execParam r:type="0066EB7A-4118-4DA0-9E98-ECDE203CA945">
 +          <n2:value xmlns:n2="http://dev.rcware.eu/scada/basic-props">
 +            <n2:changes>
 +              <n2:layer name="Layer123">
 +                <n2:changes>
 +                  <n2:ch cmd="Create">
 +                    <n2:def start="2024-04-09T02:00:00.00Z" end="2024-04-09T06:00:00.00Z" state="Enabled" val="2" p="1" comment="test">
 +                      <n2:metadata/>
 +                    </n2:def>
 +                  </n2:ch>
 +                </n2:changes>
 +              </n2:layer>
 +            </n2:changes>
 +          </n2:value>
 +        </execParam>
 +      </actionDefItem>
 +    </actions>
 +  </actionDefs>
 +</executeActionsRequest></code>
 +
 +**Response**
 +
 +<code xml><?xml version="1.0" encoding="utf-8"?>
 +<executeActionsResponse xmlns:r="http://dev.rcware.eu/serialization/references" code="Ok" message="OK" xmlns="http://dev.rcware.eu/scada/error-reporting" /></code>
 +
 +
 +
 +
 +====api/get/values====
  
    * URL: /api/get/values?format=xml    * URL: /api/get/values?format=xml
    * Method: POST    * Method: POST
 +
 +===Output property===
 +
 +Nejvhodnější způsob vyčtení aktuálních hodnot datových bodů (property "Output") z jednoho nebo více projektů.
 +
 +**Request**
  
 <code javascript> <code javascript>
Řádek 438: Řádek 498:
  </vals>  </vals>
 </values></code> </values></code>
 +
 +===PlanningCalendar property===
 +
 +**Request**
 +
 +<code javascript>
 +{
 + "cred": {
 +  "t": "xxxxxx" //token
 + },
 + "propNamesToSerialize": ["PlanningCalendar"],
 + "offset": 0,
 + "count": 1000,
 + "serverState": null,
 + "dps": [{
 +   "projId": "17d3ff08-40c1-41c0-ad6a-bad4489323c7",
 +   "dpIds": ["d1243034-0809-444d-a48a-d04d800b4095"]
 +  }
 + ]
 +}
 +
 +</code>
 +
 +**Response**
 +
 +<code xml>
 +<?xml version="1.0" encoding="utf-8"?>
 +<values xmlns:r="http://dev.rcware.eu/serialization/references" nextOffset="-1" serverTime="2024-04-16T09:27:44.9304393Z" xmlns:n1="http://dev.rcware.eu/scada/basic-props" xmlns="http://dev.rcware.eu/scada/datapoints">
 +  <vals>
 +    <v projId="17d3ff08-40c1-41c0-ad6a-bad4489323c7" dataVersion="638482651650000000" serverTime="2024-04-16T09:27:44.9304393Z">
 +      <dps>
 +        <d id="d1243034-0809-444d-a48a-d04d800b4095" serAlr="true">
 +          <props>
 +            <p n="PlanningCalendar" t="2024-04-15T11:50:38.2117669Z" q="Good" r:type="11c39f56-7d5e-489b-9615-51d2daaf25f8">
 +              <n1:v defaultValue="0" emailForNotifications="" type="1">
 +                <n1:layers>
 +                  <n1:l name="Decimal" type="" defaultValue="0">
 +                    <n1:events>
 +                      <n1:e rev="3">
 +                        <n1:def start="2024-04-11T04:00:00Z" end="2024-04-11T11:00:00Z" id="2" state="Enabled" dval="12.5" p="1" comment="test" pLayer="" lastEditedBy="admin" lastEdited="2024-04-11T13:35:01.2373164Z" />
 +                      </n1:e>
 +                      <n1:e rev="4">
 +                        <n1:def start="2024-04-11T22:00:00Z" end="2024-04-12T01:00:00Z" id="3" state="Enabled" dval="5.6" p="1" comment="test2" pLayer="" lastEditedBy="admin" lastEdited="2024-04-12T06:18:17.0853588Z" />
 +                      </n1:e>
 +                    </n1:events>
 +                    <n1:items />
 +                  </n1:l>
 +                  <n1:l name="Positive" type="" defaultValue="0">
 +                    <n1:events>
 +                      <n1:e rev="3">
 +                        <n1:def start="2024-04-11T10:00:00Z" end="2024-04-11T13:00:00Z" id="2" state="Enabled" ival="25" p="1" comment="test3" pLayer="" lastEditedBy="admin" lastEdited="2024-04-11T13:22:07.0652508Z" />
 +                      </n1:e>
 +                      <n1:e rev="5">
 +                        <n1:def start="2024-04-11T22:00:00Z" end="2024-04-12T01:00:00Z" id="5" state="Enabled" ival="30" p="1" comment="test4" pLayer="" lastEditedBy="admin" lastEdited="2024-04-12T06:18:17.0853759Z" />
 +                      </n1:e>
 +                    </n1:events>
 +                    <n1:items />
 +                  </n1:l>
 +                  <n1:l name="Negative" type="" defaultValue="0">
 +                    <n1:events>
 +                      <n1:e rev="6">
 +                        <n1:def start="2024-04-11T22:00:00Z" end="2024-04-12T01:00:00Z" id="7" state="Enabled" ival="-50" p="1" comment="test5" pLayer="" lastEditedBy="admin" lastEdited="2024-04-12T06:18:17.0854241Z" />
 +                      </n1:e>
 +                    </n1:events>
 +                    <n1:items />
 +                  </n1:l>
 +                </n1:layers>
 +              </n1:v>
 +            </p>
 +          </props>
 +        </d>
 +      </dps>
 +    </v>
 +  </vals>
 +</values>
 +</code>
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
  
  
  
  • © Energocentrum Plus, s.r.o. 2017 - 2024