Differences

This shows you the differences between two versions of the page.

--- en:mervis-scada:50-api [2018/11/06 12:59]
m.chlupac
+++ en:mervis-scada:50-api [2024/05/08 10:42]
@@ Line 1: / Line 1: @@
-====== API ======
-Mervis SCADA offers open REST-like API based on JSON and XML data formats. For full description please contact our [[:en:help:support|technical support]].
-===== List of basic API methods =====
-^Function^Description|
-^api/checkCredentials||
-^api/logout||
-^api/get/projects||
-^api/get/projectData||
-^api/get/projectByParts||
-^api/get/history||
-^api/get/history/specific||
-^api/set/history||
-^api/get/values||
-^api/get/alarms||
-^api/get/alarmHistory||
-^api/get/eventHistory||
-^api/get/changes||
-^api/set/executeActions||
-^api/set/values||
-^api/set/executeAlarmOps||
-^api/set/projectPriorityRefresh||
-^api/get/schema||
-^api/get/schema/datapoints||
-^api/get/schema/values||
-^api/get/schema/image||
-===== Example =====
-====api/get/history====
-**Request**
-   * URL: /api/get/history?format=xml
-   * Method: POST
-<code javascript>
-{
-   "cred":{
-      "n":"demo", //username
-      "p":"demo" //password
-   },
-   "projId":"5abf8ca0-94ba-48df-8d3c-7ebe87a12fd0", //project ID
-   "dpId":"62cf4083-31ed-4bc1-be25-044ba837a9f0",  //single datapoint ID
-   "from":"/Date(1541199600000)/", //UTC in ms
-   "to":"/Date(1541496190357)/",  //UTC in ms
-   "offset":0,
-   "count":5000,
-   "historyState":"" //client has to send historyState value from the last response with the following request
-}
-</code>
-**Response**
-<code xml>
-<?xml version="1.0" encoding="utf-8"?>
-<getHistoryResult xmlns:r="http://dev.rcware.eu/serialization/references" r:type="b133774d-21ce-42b6-add3-57c012079c55" xmlns:n1="http://dev.rcware.eu/scada/basic-props" xmlns="http://dev.rcware.eu/scada/history">
-  <!--
-  @Interval - ISO interval of trend values defined by the database client.
-  @historyState - to be copied into the next request
-  @nextValOfs - to be copied into the next request until value -1 is reached.
-  If ts of value in not within the interval time span after the previous value's gt - some data is missing.
-  -->
-  <hist projId="5abf8ca0-94ba-48df-8d3c-7ebe87a12fd0" dpId="62cf4083-31ed-4bc1-be25-044ba837a9f0" propName="Output" interval="PT3M" historyState="" nextValOfs="-1">
-    <errMsg/>
-    <vals>
-      <!--ts - time stamp, gt - good through, value is valid in the whole time span between these two-->
-      <hv ts="2018-11-02T21:26:08.7936747Z" gt="2018-11-03T20:35:08.8060769Z">
-        <n1:v>12754</n1:v>
-      </hv>
-      <hv ts="2018-11-03T20:41:09.0100479Z" gt="2018-11-05T11:35:08.7415158Z">
-        <n1:v>12754</n1:v>
-      </hv>
-      <hv ts="2018-11-05T11:40:04.0077949Z" gt="2018-11-05T17:25:03.4285643Z">
-        <n1:v>12754</n1:v>
-      </hv>
-      <hv ts="2018-11-05T17:28:03.4133447Z" gt="2018-11-05T19:40:03.0246122Z">
-        <n1:v>12755</n1:v>
-      </hv>
-      <hv ts="2018-11-05T19:43:03.6499981Z" gt="2018-11-05T22:01:03.2620552Z">
-        <n1:v>12756</n1:v>
-      </hv>
-      <hv ts="2018-11-05T22:04:03.1530787Z" gt="2018-11-06T02:37:03.454926Z">
-        <n1:v>12757</n1:v>
-      </hv>
-      <hv ts="2018-11-06T02:40:03.61157Z" gt="2018-11-06T04:52:03.1759539Z">
-        <n1:v>12758</n1:v>
-      </hv>
-      <hv ts="2018-11-06T04:55:03.14511Z" gt="2018-11-06T06:40:03.8621601Z">
-        <n1:v>12759</n1:v>
-      </hv>
-      <hv ts="2018-11-06T06:43:03.2063072Z" gt="2018-11-06T08:55:03.3019409Z">
-        <n1:v>12760</n1:v>
-      </hv>
-      <hv ts="2018-11-06T08:58:03.083875Z" gt="2018-11-06T09:10:03.0695797Z">
-        <n1:v>12761</n1:v>
-      </hv>
-      <hv ts="2018-11-06T09:13:03.5389214Z" gt="2018-11-06T09:19:03.5238805Z">
-        <n1:v>12761</n1:v>
-      </hv>
-      <!-- value without gt - ts and gt are equal-->
-      <hv ts="2018-11-06T09:22:03.9461503Z">
-        <n1:v>12761</n1:v>
-      </hv>
-    </vals>
-  </hist>
-</getHistoryResult>
-</code>