{
 "openapi": "3.0.3",
 "info": {
  "title": "ProMoS DMS JSON Data Exchange",
  "version": "1.10",
  "description": "Interface between external applications and the ProMoS data management system (DMS) of ProMoS NG and ProMoS NT.\n\nThe ProMoS DMS JSON Data Exchange is the interface between external applications and the ProMoS data management system (DMS). It lets you read and write data points, read historical data, change logs and alarms, monitor data points and import/export data.\n\n- **Base path** for all data exchange: `/json_data` – for authentication: `/json_auth`.\n- **Ports** (configurable in the DMS communication properties): `9020` for HTTP/WebSocket, `9021` for HTTPS/WSS. Both are enabled by default.\n- **Request format:** a JSON object whose key is the command and whose value is an array of objects – e.g. `{\"get\": [{\"path\": \"EXMPL1:T11:MN:003:Vis:VMC_power\"}]}`. The response has the same structure, one result object per request object, in the same order.\n- All examples in this documentation show only the JSON content (HTTP body or WebSocket message payload).",
  "contact": {
   "name": "MST Systemtechnik AG",
   "url": "https://www.promosng.ch"
  }
 },
 "servers": [
  {
   "url": "http://localhost:9020",
   "description": "HTTP / WebSocket (local clients only by default)"
  },
  {
   "url": "https://{host}:9021",
   "description": "HTTPS / WSS (authentication required)",
   "variables": {
    "host": {
     "default": "localhost"
    }
   }
  }
 ],
 "tags": [
  {
   "name": "Data Points"
  },
  {
   "name": "Change Logs"
  },
  {
   "name": "Alarms"
  },
  {
   "name": "System"
  },
  {
   "name": "Interpolation Templates"
  },
  {
   "name": "Node References"
  },
  {
   "name": "Authentication"
  },
  {
   "name": "Import / Export"
  }
 ],
 "paths": {
  "/json_data": {
   "post": {
    "tags": [
     "Data Points",
     "Change Logs",
     "Alarms",
     "System",
     "Interpolation Templates",
     "Node References"
    ],
    "operationId": "jsonData",
    "summary": "DMS JSON commands",
    "description": "Send one of the following commands as JSON object (HTTP POST body or WebSocket message):\n\n- `get` – Read data point values, query the DMS tree and read historical data.\n- `set` – Write data point values, states, references or historical data (optionally creating data points).\n- `rename` – Rename (move) data points or change the type of a data point.\n- `copy` – Copy data points to a destination path.\n- `updateBMO` – Balance (update) the DMS instances of a BMO object definition.\n- `delete` – Delete data points or a range of their historical data.\n- `subscribe` (WebSocket only) – Monitor data points for changes (WebSocket only).\n- `unsubscribe` (WebSocket only) – Stop monitoring data points (WebSocket only).\n- `verifyPcf` – Test a process control function (PCF) for a data point and return its result.\n- `changelogGetGroups` – Get all available change log groups.\n- `changelogCreate` (ProMoS NG only) – Create a new change log entry.\n- `changelogRead` – Read the content of a specific change log group.\n- `changelogCount` (ProMoS NG only) – Get counters of a specific change log group.\n- `changelogSubscribe` (WebSocket only) (ProMoS NG only) – Monitor a change log group (WebSocket only).\n- `changelogUnsubscribe` (WebSocket only) (ProMoS NG only) – Unsubscribe a monitored change log group (WebSocket only).\n- `alarmGetGroups` (ProMoS NG only) – Get all available alarm groups.\n- `alarmCreate` (ProMoS NG only) – Create a new alarm.\n- `alarmRead` (ProMoS NG only) – Read the content of a specific alarm group.\n- `alarmAcknowledge` (ProMoS NG only) – Acknowledge an alarm.\n- `alarmCount` (ProMoS NG only) – Get counters of a specific alarm group.\n- `alarmSubscribe` (WebSocket only) (ProMoS NG only) – Monitor alarms (WebSocket only).\n- `alarmUnsubscribe` (WebSocket only) (ProMoS NG only) – Unsubscribe monitored alarms (WebSocket only).\n- `alarmSubscribeCount` (WebSocket only) (ProMoS NG only) – Monitor alarm counters (WebSocket only).\n- `alarmUnsubscribeCount` (WebSocket only) (ProMoS NG only) – Unsubscribe monitored alarm counters (WebSocket only).\n- `version` (ProMoS NG only) – Get version information and capabilities of the DMS.\n- `interpolateGetTemplates` (ProMoS NG only) – Get predefined interpolation parameter templates.\n- `nodeReferences` (ProMoS NG only) – Get predefined node references.",
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "oneOf": [
         {
          "$ref": "#/components/schemas/GetRequest"
         },
         {
          "$ref": "#/components/schemas/SetRequest"
         },
         {
          "$ref": "#/components/schemas/RenameRequest"
         },
         {
          "$ref": "#/components/schemas/CopyRequest"
         },
         {
          "$ref": "#/components/schemas/UpdateBMORequest"
         },
         {
          "$ref": "#/components/schemas/DeleteRequest"
         },
         {
          "$ref": "#/components/schemas/SubscribeRequest"
         },
         {
          "$ref": "#/components/schemas/UnsubscribeRequest"
         },
         {
          "$ref": "#/components/schemas/VerifyPcfRequest"
         },
         {
          "$ref": "#/components/schemas/ChangelogGetGroupsRequest"
         },
         {
          "$ref": "#/components/schemas/ChangelogCreateRequest"
         },
         {
          "$ref": "#/components/schemas/ChangelogReadRequest"
         },
         {
          "$ref": "#/components/schemas/ChangelogCountRequest"
         },
         {
          "$ref": "#/components/schemas/ChangelogSubscribeRequest"
         },
         {
          "$ref": "#/components/schemas/ChangelogUnsubscribeRequest"
         },
         {
          "$ref": "#/components/schemas/AlarmGetGroupsRequest"
         },
         {
          "$ref": "#/components/schemas/AlarmCreateRequest"
         },
         {
          "$ref": "#/components/schemas/AlarmReadRequest"
         },
         {
          "$ref": "#/components/schemas/AlarmAcknowledgeRequest"
         },
         {
          "$ref": "#/components/schemas/AlarmCountRequest"
         },
         {
          "$ref": "#/components/schemas/AlarmSubscribeRequest"
         },
         {
          "$ref": "#/components/schemas/AlarmUnsubscribeRequest"
         },
         {
          "$ref": "#/components/schemas/AlarmSubscribeCountRequest"
         },
         {
          "$ref": "#/components/schemas/AlarmUnsubscribeCountRequest"
         },
         {
          "$ref": "#/components/schemas/VersionRequest"
         },
         {
          "$ref": "#/components/schemas/InterpolateGetTemplatesRequest"
         },
         {
          "$ref": "#/components/schemas/NodeReferencesRequest"
         }
        ]
       },
       "examples": {
        "get": {
         "summary": "get: Read three data points",
         "value": {
          "get": [
           {
            "path": "EXMPL1:T11:MN:003:Vis:VMC_energy1"
           },
           {
            "path": "EXMPL1:T11:MN:003:Vis:VEnergy1V"
           },
           {
            "path": "EXMPL1:T11:MN:003:Vis:VMC_power"
           }
          ]
         }
        },
        "get_3": {
         "summary": "get: Short request",
         "value": {
          "get": [
           "EXMPL1:T11:MN:003:Vis:VMC_energy1",
           "EXMPL1:T11:MN:003:Vis:VEnergy1V",
           "EXMPL1:T11:MN:003:Vis:VMC_power"
          ]
         }
        },
        "get_4": {
         "summary": "get: Query whole DMS with limit/offset",
         "value": {
          "get": [
           {
            "path": "",
            "query": {
             "maxDepth": 0,
             "limit": 100,
             "offset": 0
            }
           }
          ]
         }
        },
        "get_5": {
         "summary": "get: Query examples",
         "value": {
          "get": [
           {
            "path": "",
            "query": {
             "regExPath": "^(?!(BMO|System)).*$",
             "maxDepth": 0
            }
           },
           {
            "path": "EXMPL1:T11",
            "query": {
             "regExPath": ".*:Istwert",
             "regExValue": "[0]",
             "maxDepth": 0
            }
           },
           {
            "path": "",
            "query": {
             "regExValue": "true",
             "isType": "bool",
             "maxDepth": 0
            }
           },
           {
            "path": "EXMPL1:T11",
            "query": {
             "hasHistData": true,
             "maxDepth": 0
            }
           }
          ]
         }
        },
        "get_6": {
         "summary": "get: Historical data of all data points with recording (query + histData)",
         "value": {
          "get": [
           {
            "path": "",
            "query": {
             "hasHistData": true,
             "maxDepth": 0
            },
            "histData": {
             "start": "2015-04-04T00:00:00Z",
             "end": "2015-04-05T00:00:00Z",
             "interval": 900,
             "format": "detail"
            }
           }
          ]
         }
        },
        "get_7": {
         "summary": "get: Historical data, compact format",
         "value": {
          "get": [
           {
            "path": "System:NT:Perf:SYSTEM",
            "histData": {
             "start": "2015-04-01T00:00:00Z",
             "interval": 100
            }
           }
          ]
         }
        },
        "get_8": {
         "summary": "get: Historical data, detail format",
         "value": {
          "get": [
           {
            "path": "System:NT:Perf:DMS",
            "histData": {
             "start": "2015-01-01T00:00:00Z",
             "end": "2015-05-31T00:00:00Z",
             "format": "detail"
            }
           }
          ]
         }
        },
        "get_9": {
         "summary": "get: Child query (ProMoS NG)",
         "value": {
          "get": [
           {
            "path": "",
            "query": {
             "maxDepth": 0,
             "childs": [
              {
               "pathPart": "_DeviceName",
               "value": "Device-50012",
               "valueCompare": "eq"
              },
              {
               "pathPart": "object-type",
               "value": "calendar (",
               "valueCompare": "startsWith"
              },
              {
               "pathPart": "date-list-jext",
               "return": true
              }
             ]
            }
           }
          ]
         }
        },
        "get_10": {
         "summary": "get: Historical data with filter and normalization (ProMoS NG)",
         "value": {
          "get": [
           {
            "path": "EXMPL1:Room1:Temp",
            "histData": {
             "start": "2023-03-20T00:00:00,000+01:00",
             "interval": -1,
             "interpolateMethod": "meanA",
             "filterParams": [
              {
               "timeStart": "22:00:00",
               "duration": 7200,
               "weekDays": [
                1,
                2,
                3,
                4,
                5
               ]
              },
              {
               "timeStart": "00:00:00",
               "duration": 7200,
               "weekDays": [
                2,
                3,
                4,
                5,
                6
               ]
              }
             ],
             "normalizeParams": [
              {
               "method": "prevNextLinearFill",
               "interval": 900
              }
             ]
            }
           }
          ]
         }
        },
        "set": {
         "summary": "set: Write values",
         "value": {
          "whois": "DriverXY",
          "user": "",
          "set": [
           {
            "path": "EXMPL1:T11:MN:003:Vis:VMC_energy1",
            "value": 4.4565467567867,
            "type": "double"
           },
           {
            "path": "EXMPL1:T11:MN:003:Vis:VEnergy1V",
            "value": -1,
            "type": "double",
            "stamp": "2015-03-11T05:27:39,027+01:00"
           },
           {
            "path": "EXMPL1:TEST:BOOLEAN",
            "value": true,
            "create": true,
            "type": "bool"
           },
           {
            "path": "EXMPL1:TEST:INT",
            "value": 44,
            "type": "int"
           },
           {
            "path": "EXMPL1:TEST:STRING",
            "value": "some long example message",
            "type": "string"
           }
          ]
         }
        },
        "set_2": {
         "summary": "set: Write historical data (mixed compact/detail)",
         "value": {
          "whois": "DriverXY",
          "user": "",
          "set": [
           {
            "path": "EXMPL1:T11:MN:003:Vis:VMC_energy1",
            "histData": [
             {
              "2015-04-03T04:33:20,000+02:00": 0.32780084013938904
             },
             {
              "2015-04-03T04:35:00,000+02:00": 0.7427386045455933
             },
             {
              "stamp": "2015-04-03T04:37:00,000+02:00",
              "value": 0.5,
              "state": "inv"
             },
             {
              "2015-04-17T08:37:40,000+02:00": 0.6244444251060486
             }
            ]
           }
          ]
         }
        },
        "set_3": {
         "summary": "set: Write node references (ProMoS NG)",
         "value": {
          "whois": "DriverXY",
          "user": "",
          "set": [
           {
            "path": "EXMPL1:Room1:Temp",
            "refs": [
             {
              "id": 1,
              "value": true
             },
             {
              "id": 3478,
              "value": {
               "test": 1
              }
             }
            ]
           }
          ]
         }
        },
        "set_4": {
         "summary": "set: Multiple commands in one request (order not guaranteed)",
         "value": {
          "whois": "DriverXY",
          "user": "",
          "set": [
           {
            "path": "EXMPL1:T11:MN:003:Vis:VMC_power",
            "value": 4.4444
           }
          ],
          "get": [
           {
            "path": "EXMPL1:T11:MN:003:Vis:VMC_power"
           }
          ]
         }
        },
        "rename": {
         "summary": "rename: Rename data points",
         "value": {
          "whois": "DriverXY",
          "rename": [
           {
            "path": "EXMPL1:T11:MN:003",
            "newPath": "EXMPL1:T11:MN:002"
           },
           {
            "path": "EXMPL1:T11:MN:003",
            "newPath": "EXMPL1:T11:MN:002"
           }
          ]
         }
        },
        "copy": {
         "summary": "copy: Copy data points",
         "value": {
          "whois": "DriverXY",
          "copy": [
           {
            "path": "EXMPL1:T11:MN:003",
            "destPath": "EXMPL1:T11:MN:002"
           },
           {
            "path": "EXMPL1:T11:MN:003",
            "destPath": "EXMPL1:T11:MN:002"
           }
          ]
         }
        },
        "updateBMO": {
         "summary": "updateBMO: Update BMO object",
         "value": {
          "whois": "DriverXY",
          "updateBMO": [
           {
            "object": "MOT01"
           }
          ]
         }
        },
        "delete": {
         "summary": "delete: Delete data points",
         "value": {
          "whois": "DriverXY",
          "delete": [
           {
            "path": "EXMPL1:T11:MN:003"
           },
           {
            "path": "EXMPL1:T11:MN:003",
            "recursive": true
           },
           {
            "path": "EXMPL1:T11:MN:003:Vis:VEnergy1V"
           },
           {
            "path": "EXMPL1:TEST:BOOLEAN"
           }
          ]
         }
        },
        "delete_2": {
         "summary": "delete: Delete historical data range",
         "value": {
          "whois": "DriverXY",
          "user": "",
          "delete": [
           {
            "path": "EXMPL1:T11:MN:003:Vis:VMC_energy1",
            "histData": {
             "start": "2015-04-04T00:00:00Z",
             "end": "2015-04-05T00:00:00Z"
            }
           }
          ]
         }
        },
        "subscribe": {
         "summary": "subscribe: Subscribe to the System tree (response and a later event message in \"event\")",
         "value": {
          "subscribe": [
           {
            "path": "System",
            "event": "onChange",
            "query": {
             "maxDepth": 0
            }
           }
          ]
         }
        },
        "unsubscribe": {
         "summary": "unsubscribe: Unsubscribe",
         "value": {
          "unsubscribe": [
           {
            "path": "System"
           }
          ]
         }
        },
        "verifyPcf": {
         "summary": "verifyPcf: Verify a JSE process control function",
         "value": {
          "verifyPcf": [
           {
            "path": "EXMPL1:T11:MN:003:Vis:VMC_energy1",
            "pcf": "JSE ( function() { if (@{EXMPL1:Room1:Temp} < 10.0) return true; else return false; })"
           }
          ]
         }
        },
        "changelogGetGroups": {
         "summary": "changelogGetGroups: Get change log groups",
         "value": {
          "changelogGetGroups": []
         }
        },
        "changelogCreate": {
         "summary": "changelogCreate: Create change log entry",
         "value": {
          "whois": "Client",
          "changelogCreate": [
           {
            "group": "Manip1",
            "path": "EXMPL1:Room1:Test",
            "stamp": "2021-11-03T16:20:48,767+01:00",
            "user": "operator",
            "oldValue": "0",
            "newValue": "1",
            "text": "Test",
            "siteGroup": 0
           }
          ]
         }
        },
        "changelogRead": {
         "summary": "changelogRead: Read change log for a period",
         "value": {
          "changelogRead": [
           {
            "group": "ABS1",
            "start": "2016-02-29T00:00:00Z",
            "end": "2016-03-02T00:00:00Z"
           }
          ]
         }
        },
        "changelogCount": {
         "summary": "changelogCount: Count change log entries",
         "value": {
          "changelogCount": [
           {
            "group": "Manip1",
            "start": "2016-02-29T00:00:00Z",
            "end": "2016-03-02T00:00:00Z"
           }
          ]
         }
        },
        "changelogSubscribe": {
         "summary": "changelogSubscribe: Subscribe to a change log group",
         "value": {
          "changelogSubscribe": [
           {
            "group": "ABS1"
           }
          ]
         }
        },
        "changelogUnsubscribe": {
         "summary": "changelogUnsubscribe: Unsubscribe",
         "value": {
          "changelogUnsubscribe": [
           {
            "group": "ABS1"
           }
          ]
         }
        },
        "alarmGetGroups": {
         "summary": "alarmGetGroups: Get alarm groups",
         "value": {
          "alarmGetGroups": []
         }
        },
        "alarmCreate": {
         "summary": "alarmCreate: Create alarm",
         "value": {
          "whois": "AlarmViewer",
          "alarmCreate": [
           {
            "group": "Alarm",
            "path": "EXMPL1:Room1:AirQuality:GW_LE_Err",
            "stamp": "2021-11-03T16:20:48,767+01:00",
            "user": "operator",
            "oldValue": "0",
            "newValue": "1",
            "text": "Air quality lower limit reached",
            "state": "acknowledged",
            "priority": 2,
            "priorityDevice": 0,
            "alarmGroup": 1,
            "alarmCollectGroup": 0,
            "siteGroup": 0
           }
          ]
         }
        },
        "alarmRead": {
         "summary": "alarmRead: Read alarms for a period",
         "value": {
          "alarmRead": [
           {
            "group": "Alarm",
            "start": "2021-02-28T00:00:00Z",
            "end": "2021-03-02T00:00:00Z"
           }
          ]
         }
        },
        "alarmRead_2": {
         "summary": "alarmRead: Read historical acknowledged alarms with paging",
         "value": {
          "alarmRead": [
           {
            "group": "Alarm",
            "filter": {
             "isPending": false,
             "isHistorical": true,
             "state": [
              "acknowledged",
              "leftAcknowledged"
             ],
             "path": "EXMPL1:"
            },
            "limit": 100,
            "offset": 0
           }
          ]
         }
        },
        "alarmAcknowledge": {
         "summary": "alarmAcknowledge: Acknowledge single alarm",
         "value": {
          "whois": "AlarmViewer",
          "user": "operator",
          "alarmAcknowledge": [
           {
            "id": "EXMPL1:Heating:Valve1:Err|1",
            "action": "set",
            "level": "single"
           }
          ]
         }
        },
        "alarmCount": {
         "summary": "alarmCount: Count alarms",
         "value": {
          "alarmCount": [
           {
            "group": "Alarm",
            "start": "2021-02-28T00:00:00Z",
            "end": "2021-03-02T00:00:00Z"
           }
          ]
         }
        },
        "alarmSubscribe": {
         "summary": "alarmSubscribe: Subscribe to alarms",
         "value": {
          "alarmSubscribe": [
           {
            "group": "Alarm"
           }
          ]
         }
        },
        "alarmUnsubscribe": {
         "summary": "alarmUnsubscribe: Unsubscribe",
         "value": {
          "alarmUnsubscribe": [
           {
            "group": "Alarm"
           }
          ]
         }
        },
        "alarmSubscribeCount": {
         "summary": "alarmSubscribeCount: Subscribe to alarm counters",
         "value": {
          "alarmSubscribeCount": [
           {
            "group": "Alarm"
           }
          ]
         }
        },
        "alarmUnsubscribeCount": {
         "summary": "alarmUnsubscribeCount: Unsubscribe counters",
         "value": {
          "alarmUnsubscribeCount": [
           {
            "group": "Alarm"
           }
          ]
         }
        },
        "version": {
         "summary": "version: ProMoS NG response",
         "value": {
          "version": []
         }
        },
        "version_2": {
         "summary": "version: ProMoS NT response",
         "value": {
          "version": []
         }
        },
        "interpolateGetTemplates": {
         "summary": "interpolateGetTemplates: Get templates",
         "value": {
          "interpolateGetTemplates": []
         }
        },
        "nodeReferences": {
         "summary": "nodeReferences: Get all node references",
         "value": {
          "nodeReferences": []
         }
        },
        "nodeReferences_2": {
         "summary": "nodeReferences: Get filtered node references",
         "value": {
          "nodeReferences": [
           0,
           2
          ]
         }
        }
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Command result(s), one result object per request object.",
      "content": {
       "application/json": {
        "schema": {
         "oneOf": [
          {
           "$ref": "#/components/schemas/GetResponse"
          },
          {
           "$ref": "#/components/schemas/SetResponse"
          },
          {
           "$ref": "#/components/schemas/RenameResponse"
          },
          {
           "$ref": "#/components/schemas/CopyResponse"
          },
          {
           "$ref": "#/components/schemas/UpdateBMOResponse"
          },
          {
           "$ref": "#/components/schemas/DeleteResponse"
          },
          {
           "$ref": "#/components/schemas/SubscribeResponse"
          },
          {
           "$ref": "#/components/schemas/UnsubscribeResponse"
          },
          {
           "$ref": "#/components/schemas/VerifyPcfResponse"
          },
          {
           "$ref": "#/components/schemas/ChangelogGetGroupsResponse"
          },
          {
           "$ref": "#/components/schemas/ChangelogCreateResponse"
          },
          {
           "$ref": "#/components/schemas/ChangelogReadResponse"
          },
          {
           "$ref": "#/components/schemas/ChangelogCountResponse"
          },
          {
           "$ref": "#/components/schemas/ChangelogSubscribeResponse"
          },
          {
           "$ref": "#/components/schemas/ChangelogUnsubscribeResponse"
          },
          {
           "$ref": "#/components/schemas/AlarmGetGroupsResponse"
          },
          {
           "$ref": "#/components/schemas/AlarmCreateResponse"
          },
          {
           "$ref": "#/components/schemas/AlarmReadResponse"
          },
          {
           "$ref": "#/components/schemas/AlarmAcknowledgeResponse"
          },
          {
           "$ref": "#/components/schemas/AlarmCountResponse"
          },
          {
           "$ref": "#/components/schemas/AlarmSubscribeResponse"
          },
          {
           "$ref": "#/components/schemas/AlarmUnsubscribeResponse"
          },
          {
           "$ref": "#/components/schemas/AlarmSubscribeCountResponse"
          },
          {
           "$ref": "#/components/schemas/AlarmUnsubscribeCountResponse"
          },
          {
           "$ref": "#/components/schemas/VersionResponse"
          },
          {
           "$ref": "#/components/schemas/InterpolateGetTemplatesResponse"
          },
          {
           "$ref": "#/components/schemas/NodeReferencesResponse"
          }
         ]
        },
        "examples": {
         "get": {
          "summary": "get: Read three data points",
          "value": {
           "get": [
            {
             "path": "EXMPL1:T11:MN:003:Vis:VMC_energy1",
             "code": "ok",
             "type": "double",
             "value": 3.0,
             "stamp": "2015-03-20T07:49:19,000+01:00"
            },
            {
             "path": "EXMPL1:T11:MN:003:Vis:VEnergy1V",
             "code": "ok",
             "type": "double",
             "value": 0.0,
             "stamp": "2015-03-20T07:49:19,000+01:00"
            },
            {
             "path": "EXMPL1:T11:MN:003:Vis:VMC_power",
             "code": "ok",
             "type": "double",
             "value": 0.597,
             "stamp": "2015-03-20T07:49:19,000+01:00"
            }
           ]
          }
         },
         "get_2": {
          "summary": "get: Fatal error response",
          "value": {
           "get": [
            {
             "code": "error",
             "message": "Expected JSON encoded data, but got something else."
            }
           ]
          }
         },
         "get_4": {
          "summary": "get: Query whole DMS with limit/offset",
          "value": {
           "get": [
            {
             "path": "",
             "code": "ok",
             "type": "none",
             "value": null,
             "stamp": "2015-03-20T07:49:19,000+01:00",
             "readonly": true,
             "hasChild": true
            },
            {
             "code": "limitReached",
             "message": "Chosen limit reached",
             "limit": 100,
             "nextOffset": 200
            }
           ]
          }
         },
         "get_7": {
          "summary": "get: Historical data, compact format",
          "value": {
           "get": [
            {
             "path": "System:NT:Perf:SYSTEM",
             "code": "ok",
             "type": "double",
             "value": 0.0,
             "stamp": null,
             "histData": [
              {
               "2015-04-03T04:33:20,000+02:00": 0.32780084013938904
              },
              {
               "2015-04-03T04:35:00,000+02:00": 0.7427386045455933
              },
              {
               "2015-04-17T08:37:40,000+02:00": 0.6244444251060486
              }
             ]
            }
           ]
          }
         },
         "get_8": {
          "summary": "get: Historical data, detail format",
          "value": {
           "get": [
            {
             "path": "System:NT:Perf:DMS",
             "code": "ok",
             "type": "double",
             "value": 0.0,
             "stamp": null,
             "histData": [
              {
               "stamp": "2015-04-03T04:45:00,000+02:00",
               "value": 0.0,
               "state": "ok",
               "rec": "cycle"
              },
              {
               "stamp": "2015-04-03T05:00:00,000+02:00",
               "value": 0.0,
               "state": "ok",
               "rec": "cycle"
              }
             ]
            }
           ]
          }
         },
         "set": {
          "summary": "set: Write values",
          "value": {
           "set": [
            {
             "code": "ok",
             "path": "EXMPL1:T11:MN:003:Vis:VMC_energy1",
             "value": 3,
             "type": "double",
             "stamp": "2015-03-20T07:49:19,000+01:00"
            },
            {
             "code": "ok",
             "path": "EXMPL1:T11:MN:003:Vis:VEnergy1V",
             "value": 0,
             "type": "double",
             "stamp": "2015-03-11T05:27:39,027+01:00"
            },
            {
             "code": "no perm",
             "path": "EXMPL1:TEST:BOOLEAN"
            },
            {
             "code": "error",
             "path": "EXMPL1:TEST:INT",
             "message": "Data point doesn't exist"
            },
            {
             "code": "error",
             "path": "EXMPL1:TEST:STRING",
             "message": "Data type doesn't match"
            }
           ]
          }
         },
         "set_2": {
          "summary": "set: Write historical data (mixed compact/detail)",
          "value": {
           "set": [
            {
             "code": "ok",
             "path": "EXMPL1:T11:MN:003:Vis:VMC_energy1"
            }
           ]
          }
         },
         "set_4": {
          "summary": "set: Multiple commands in one request (order not guaranteed)",
          "value": {
           "get": [
            {
             "path": "EXMPL1:T11:MN:003:Vis:VMC_power",
             "code": "ok",
             "type": "double",
             "value": 1.1111,
             "stamp": "2015-03-20T04:23:44,000+01:00"
            }
           ],
           "set": [
            {
             "path": "EXMPL1:T11:MN:003:Vis:VMC_power",
             "code": "ok",
             "type": "double",
             "value": 4.4444,
             "stamp": "2015-03-20T07:49:19,000+01:00"
            }
           ]
          }
         },
         "rename": {
          "summary": "rename: Rename data points",
          "value": {
           "rename": [
            {
             "code": "ok",
             "path": "EXMPL1:T11:MN:003",
             "newPath": "EXMPL1:T11:MN:002"
            },
            {
             "code": "not found",
             "path": "EXMPL1:T11:MN:003",
             "message": "Data point doesn't exist"
            }
           ]
          }
         },
         "copy": {
          "summary": "copy: Copy data points",
          "value": {
           "copy": [
            {
             "code": "ok",
             "path": "EXMPL1:T11:MN:003",
             "destPath": "EXMPL1:T11:MN:002"
            },
            {
             "code": "error",
             "path": "EXMPL1:T11:MN:003",
             "destPath": "EXMPL1:T11:MN:002",
             "message": "Could not copy, destPath exists"
            }
           ]
          }
         },
         "updateBMO": {
          "summary": "updateBMO: Update BMO object",
          "value": {
           "updateBMO": [
            {
             "code": "ok",
             "object": "MOT01"
            }
           ]
          }
         },
         "delete": {
          "summary": "delete: Delete data points",
          "value": {
           "delete": [
            {
             "code": "error",
             "path": "EXMPL1:T11:MN:003",
             "message": "Path is not empty"
            },
            {
             "code": "ok",
             "path": "EXMPL1:T11:MN:003"
            },
            {
             "code": "not found",
             "path": "EXMPL1:T11:MN:003:Vis:VEnergy1V",
             "message": "Data point doesn't exist"
            },
            {
             "code": "ok",
             "path": "EXMPL1:TEST:BOOLEAN"
            }
           ]
          }
         },
         "delete_2": {
          "summary": "delete: Delete historical data range",
          "value": {
           "delete": [
            {
             "code": "ok",
             "path": "EXMPL1:T11:MN:003:Vis:VMC_energy1"
            }
           ]
          }
         },
         "subscribe": {
          "summary": "subscribe: Subscribe to the System tree (response and a later event message in \"event\")",
          "value": {
           "subscribe": [
            {
             "code": "ok",
             "path": "System",
             "type": "none",
             "value": null,
             "stamp": null,
             "event": "onChange",
             "query": {
              "maxDepth": 0
             }
            }
           ]
          }
         },
         "verifyPcf": {
          "summary": "verifyPcf: Verify a JSE process control function",
          "value": {
           "verifyPcf": [
            {
             "path": "EXMPL1:T11:MN:003:Vis:VMC_energy1",
             "code": "ok",
             "message": "",
             "result": true
            }
           ]
          }
         },
         "verifyPcf_2": {
          "summary": "verifyPcf: Fatal error response",
          "value": {
           "verifyPcf": [
            {
             "code": "error",
             "message": "Expected JSON encoded data, but got something else."
            }
           ]
          }
         },
         "changelogGetGroups": {
          "summary": "changelogGetGroups: Get change log groups",
          "value": {
           "changelogGetGroups": [
            {
             "code": "ok",
             "groups": [
              "login",
              "Ereign1",
              "Alarm",
              "Manip1"
             ]
            }
           ]
          }
         },
         "changelogCreate": {
          "summary": "changelogCreate: Create change log entry",
          "value": {
           "changelogCreate": [
            {
             "code": "ok",
             "id": "EXMPL1:Room1:Test|1"
            }
           ]
          }
         },
         "changelogRead": {
          "summary": "changelogRead: Read change log for a period",
          "value": {
           "changelogRead": [
            {
             "code": "ok",
             "group": "ABS1",
             "changelog": [
              {
               "id": "EXMPL1:Heating:Valve1:ABS_Ein|0|165382260",
               "path": "EXMPL1:Heating:Valve1:ABS_Ein",
               "stamp": "2016-02-29T11:48:55,715+01:00",
               "text": "Heating valve off"
              },
              {
               "id": "EXMPL1:Heating:Valve1:ABS_Ein|0|165337860",
               "path": "EXMPL1:Heating:Valve1:ABS_Ein",
               "stamp": "2016-02-29T11:42:58,197+01:00",
               "text": "Heating valve on"
              }
             ]
            }
           ]
          }
         },
         "changelogCount": {
          "summary": "changelogCount: Count change log entries",
          "value": {
           "changelogCount": [
            {
             "code": "ok",
             "group": "Manip1",
             "countTotal": 165
            }
           ]
          }
         },
         "changelogSubscribe": {
          "summary": "changelogSubscribe: Subscribe to a change log group",
          "value": {
           "changelogSubscribe": [
            {
             "code": "ok",
             "group": "ABS1"
            }
           ]
          }
         },
         "changelogUnsubscribe": {
          "summary": "changelogUnsubscribe: Unsubscribe",
          "value": {
           "changelogUnsubscribe": [
            {
             "code": "ok",
             "group": "ABS1"
            }
           ]
          }
         },
         "alarmGetGroups": {
          "summary": "alarmGetGroups: Get alarm groups",
          "value": {
           "alarmGetGroups": [
            {
             "code": "ok",
             "groups": [
              "Alarm",
              "Service"
             ]
            }
           ]
          }
         },
         "alarmCreate": {
          "summary": "alarmCreate: Create alarm",
          "value": {
           "alarmCreate": [
            {
             "code": "ok",
             "id": "EXMPL1:Room1:AirQuality:GW_LE_Err|1"
            }
           ]
          }
         },
         "alarmRead": {
          "summary": "alarmRead: Read alarms for a period",
          "value": {
           "alarmRead": [
            {
             "group": "Alarm",
             "code": "ok",
             "alarms": [
              {
               "id": "EXMPL1:Room1:AirQuality:GW_LE_Err|1",
               "stamp": "2021-11-03T16:20:48,767+01:00",
               "path": "EXMPL1:Room1:AirQuality:GW_LE_Err",
               "user": "1:web@WebServer:localhost",
               "oldValue": "0",
               "newValue": "1",
               "text": "03.11.21 16:20:48 EXMPL1:Room1:AirQuality:GW_LE_Err Air quality lower limit reached  quit 1:web@WebServer:localhost",
               "siteGroup": 0,
               "group": "Alarm",
               "isPending": true,
               "alarmCfgNr": 1,
               "state": "acknowledged",
               "priority": 2,
               "priorityDevice": 0,
               "alarmGroup": 1,
               "alarmCollectGroup": 0
              },
              {
               "id": "EXMPL1:Room1:AirQuality:FBr_Err|1",
               "stamp": "2021-11-03T16:20:48,717+01:00",
               "path": "EXMPL1:Room1:AirQuality:FBr_Err",
               "user": "1:web@WebServer:localhost",
               "oldValue": "0",
               "newValue": "1",
               "text": "03.11.21 16:20:48 EXMPL1:Room1:AirQuality:FBr_Err Air quality sensor break  quit 1:web@WebServer:localhost",
               "siteGroup": 0,
               "group": "Alarm",
               "isPending": true,
               "alarmCfgNr": 1,
               "state": "acknowledged",
               "priority": 2,
               "priorityDevice": 0,
               "alarmGroup": 1,
               "alarmCollectGroup": 0
              }
             ]
            }
           ]
          }
         },
         "alarmAcknowledge": {
          "summary": "alarmAcknowledge: Acknowledge single alarm",
          "value": {
           "alarmAcknowledge": [
            {
             "code": "ok",
             "group": "",
             "id": "EXMPL1:Heating:Valve1:Err|1",
             "action": "set"
            }
           ]
          }
         },
         "alarmCount": {
          "summary": "alarmCount: Count alarms",
          "value": {
           "alarmCount": [
            {
             "code": "ok",
             "group": "Alarm",
             "countTotal": 165,
             "countAlarm": {
              "occurred": 32,
              "left": 100,
              "acknowledged": 20,
              "leftAcknowledged": 13
             }
            }
           ]
          }
         },
         "alarmSubscribe": {
          "summary": "alarmSubscribe: Subscribe to alarms",
          "value": {
           "alarmSubscribe": [
            {
             "code": "ok",
             "group": "Alarm"
            }
           ]
          }
         },
         "alarmUnsubscribe": {
          "summary": "alarmUnsubscribe: Unsubscribe",
          "value": {
           "alarmUnsubscribe": [
            {
             "code": "ok",
             "group": "Alarm"
            }
           ]
          }
         },
         "alarmSubscribeCount": {
          "summary": "alarmSubscribeCount: Subscribe to alarm counters",
          "value": {
           "alarmSubscribeCount": [
            {
             "code": "ok",
             "group": "Alarm"
            }
           ]
          }
         },
         "alarmUnsubscribeCount": {
          "summary": "alarmUnsubscribeCount: Unsubscribe counters",
          "value": {
           "alarmUnsubscribeCount": [
            {
             "code": "ok",
             "group": "Alarm"
            }
           ]
          }
         },
         "version": {
          "summary": "version: ProMoS NG response",
          "value": {
           "version": [
            {
             "code": "ok",
             "app": "DMS",
             "copyright": "Copyright (c) 2022 MST Systemtechnik AG",
             "description": "ProMoS NG Data Management Service",
             "date": "2023-10-02 13:56",
             "appVersion": {
              "full": "2.23.110.206",
              "major": 2,
              "minor": 23,
              "setup": 110,
              "build": 206
             },
             "setupVersion": {
              "full": "2.23.110.24",
              "major": 2,
              "minor": 23,
              "setup": 110,
              "build": 24
             },
             "capabilities": {
              "commands": [
               "version",
               "get",
               "get-histData",
               "get-histData-interpolate",
               "get-query-limit",
               "set",
               "set-histData",
               "delete",
               "delete-histData",
               "rename",
               "copy",
               "updateBMO",
               "verifyPcf",
               "changelogGetGroups",
               "changelogRead",
               "changelogCount",
               "alarmGetGroups",
               "alarmRead",
               "alarmCount",
               "alarmAcknowledge",
               "interpolateGetTemplates",
               "validateUser",
               "subscribe",
               "unsubscribe",
               "changelogSubscribe",
               "changelogUnsubscribe",
               "alarmSubscribe",
               "alarmUnsubscribe",
               "alarmSubscribeCount",
               "alarmUnsubscribeCount",
               "HTTP_import-v1",
               "HTTP_import-v2",
               "HTTP_export-v1",
               "HTTP_export-v2"
              ],
              "limitations": [
               {
                "maxPathLength": 65535,
                "queryMaxDepth": 255,
                "queryMaxResults": 150000,
                "histdataMaxResults": 610000,
                "changelogMaxResults": 100000,
                "websocketMaxReceiveFrameSize": 4194304,
                "websocketMaxReceiveMessageSize": 4194304
               }
              ]
             }
            }
           ]
          }
         },
         "version_2": {
          "summary": "version: ProMoS NT response",
          "value": {
           "version": [
            {
             "code": "error",
             "message": "Unknown command. version"
            }
           ]
          }
         },
         "interpolateGetTemplates": {
          "summary": "interpolateGetTemplates: Get templates",
          "value": {
           "interpolateGetTemplates": [
            {
             "code": "ok",
             "templates": [
              {
               "name": "RawValues",
               "description": "",
               "dataClasses": [
                "any"
               ],
               "usages": [
                "any",
                "BAI"
               ],
               "interpolateParam": {
                "method": "",
                "interval": 0
               }
              },
              {
               "name": "EnergyCounterUp",
               "description": "",
               "dataClasses": [
                "counterUp"
               ],
               "usages": [
                "any",
                "BAI"
               ],
               "interpolateParam": {
                "method": "diffCtrUpCleaned"
               }
              }
             ]
            }
           ]
          }
         },
         "nodeReferences": {
          "summary": "nodeReferences: Get all node references",
          "value": {
           "nodeReferences": [
            {
             "code": "ok",
             "references": [
              {
               "id": 0,
               "name": "DeviceSetpoint",
               "description": "Setpoint value on Device"
              },
              {
               "id": 1,
               "name": "DeviceInput",
               "description": "Only input value on decice"
              },
              {
               "id": 2,
               "name": "DeviceDigital",
               "description": "Digital value on device"
              }
             ]
            }
           ]
          }
         }
        }
       }
      }
     },
     "400": {
      "description": "Fatal error (plain-text message).",
      "content": {
       "text/plain": {
        "schema": {
         "type": "string"
        }
       }
      }
     },
     "401": {
      "description": "Authentication required (secure connections)."
     },
     "405": {
      "description": "Only POST requests are allowed.",
      "content": {
       "text/plain": {
        "schema": {
         "type": "string"
        },
        "example": "Use POST requests."
       }
      }
     }
    }
   }
  },
  "/json_auth": {
   "post": {
    "tags": [
     "Authentication"
    ],
    "operationId": "jsonAuth",
    "summary": "Authentication commands",
    "description": "Send one of the following commands as JSON object (HTTP POST body or WebSocket message):\n\n- `validateUser` – Validate local ProMoS user(s).",
    "requestBody": {
     "required": true,
     "content": {
      "application/json": {
       "schema": {
        "oneOf": [
         {
          "$ref": "#/components/schemas/ValidateUserRequest"
         }
        ]
       },
       "examples": {
        "validateUser": {
         "summary": "validateUser: Validate a user",
         "value": {
          "validateUser": [
           {
            "loginName": "test",
            "password": "<password>"
           }
          ]
         }
        }
       }
      }
     }
    },
    "responses": {
     "200": {
      "description": "Command result(s), one result object per request object.",
      "content": {
       "application/json": {
        "schema": {
         "oneOf": [
          {
           "$ref": "#/components/schemas/ValidateUserResponse"
          }
         ]
        },
        "examples": {
         "validateUser": {
          "summary": "validateUser: Validate a user",
          "value": {
           "validateUser": [
            {
             "loginName": "test",
             "userData": {
              "userName": "test",
              "comment": "This is a test user",
              "language": "ger",
              "host": "",
              "startImage": "Main",
              "isAdmin": true,
              "isUserAdmin": false,
              "hasAutoLogin": false,
              "hasAutoLogoff": false,
              "allowedWebAccess": true,
              "accessLevels": [
               1,
               2,
               3,
               4,
               8,
               15,
               16
              ],
              "stationLevels": [
               1,
               2,
               3,
               8
              ]
             }
            }
           ]
          }
         },
         "validateUser_2": {
          "summary": "validateUser: Fatal error",
          "value": {
           "validateUser": [
            {
             "code": "error",
             "message": "Expected JSON encoded data, but got something else."
            }
           ]
          }
         }
        }
       }
      }
     },
     "400": {
      "description": "Fatal error (plain-text message).",
      "content": {
       "text/plain": {
        "schema": {
         "type": "string"
        }
       }
      }
     },
     "401": {
      "description": "Authentication required (secure connections)."
     },
     "405": {
      "description": "Only POST requests are allowed.",
      "content": {
       "text/plain": {
        "schema": {
         "type": "string"
        },
        "example": "Use POST requests."
       }
      }
     }
    }
   }
  },
  "/import/v1": {
   "put": {
    "tags": [
     "Import / Export"
    ],
    "summary": "Import data points (v1 format).",
    "description": "Only for ProMoS NG. Imports data points sent in the request body (HTTP(S) PUT). Any existing data point is overwritten with the new values. Lines without error are imported; lines with errors are reported in the `errors` array of the JSON response.\n\nFormats:\n\n- **v1**: traditional ProMoS NT storage format, always ISO 8859-1 (Latin1) encoded CSV without header; fields `path;type;value;readwriteFlag`. Restriction: time stamp and state are not present.\n- **v2**: JSON Lines (https://jsonlines.org/), always UTF-8; one object per line with `path`, `type`, `value`, `stamp`, `state` (see schema ExportDataPointV2Line).\n\nIn case of a fatal error any HTTP status code (like 400, 404, 405...) is returned.",
    "parameters": [
     {
      "name": "path",
      "in": "query",
      "required": false,
      "description": "The start path for the import. Default: empty (root path).",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "onlyChilds",
      "in": "query",
      "required": false,
      "description": "If true, the largest common part of the paths being imported is excluded from the import. Default: false.",
      "schema": {
       "type": "boolean",
       "default": false
      }
     }
    ],
    "responses": {
     "200": {
      "description": "Import result (schema ImportDataPointsResult).",
      "content": {
       "application/json": {
        "schema": {
         "type": "string"
        },
        "example": {
         "beforeImport": {
          "nodes": 196544,
          "pcf": 23958
         },
         "afterImport": {
          "nodes": 196553,
          "pcf": 23958
         },
         "errors": [
          "Parse error at offset 1: 'Missing a name for object member.' on line 4 ({xxyy\"path\":\"EXMPL1:E0\",\"type\":\"bool\",\"value\":false,\"stamp\":\"2021-06-10T11:43:51,757+02:00\",\"state\":\"ok\"})"
         ]
        }
       }
      }
     }
    },
    "requestBody": {
     "description": "Data points in v1 format.",
     "content": {
      "text/csv; charset=ISO-8859-1": {
       "schema": {
        "type": "string"
       },
       "example": "EXMPL1:Room1:Temp:GW_Lo:PLC:Station;DWS;1;RW\nEXMPL1:Room1:Temp:GW_Lo:PLC:Telegram;DWS;101;RW\n"
      }
     }
    }
   }
  },
  "/import/v2": {
   "put": {
    "tags": [
     "Import / Export"
    ],
    "summary": "Import data points (v2 format).",
    "description": "Only for ProMoS NG. Imports data points sent in the request body (HTTP(S) PUT). Any existing data point is overwritten with the new values. Lines without error are imported; lines with errors are reported in the `errors` array of the JSON response.\n\nFormats:\n\n- **v1**: traditional ProMoS NT storage format, always ISO 8859-1 (Latin1) encoded CSV without header; fields `path;type;value;readwriteFlag`. Restriction: time stamp and state are not present.\n- **v2**: JSON Lines (https://jsonlines.org/), always UTF-8; one object per line with `path`, `type`, `value`, `stamp`, `state` (see schema ExportDataPointV2Line).\n\nIn case of a fatal error any HTTP status code (like 400, 404, 405...) is returned.",
    "parameters": [
     {
      "name": "path",
      "in": "query",
      "required": false,
      "description": "The start path for the import. Default: empty (root path).",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "onlyChilds",
      "in": "query",
      "required": false,
      "description": "If true, the largest common part of the paths being imported is excluded from the import. Default: false.",
      "schema": {
       "type": "boolean",
       "default": false
      }
     }
    ],
    "responses": {
     "200": {
      "description": "Import result (schema ImportDataPointsResult).",
      "content": {
       "application/json": {
        "schema": {
         "type": "string"
        },
        "example": {
         "beforeImport": {
          "nodes": 196544,
          "pcf": 23958
         },
         "afterImport": {
          "nodes": 196553,
          "pcf": 23958
         },
         "errors": [
          "Parse error at offset 1: 'Missing a name for object member.' on line 4 ({xxyy\"path\":\"EXMPL1:E0\",\"type\":\"bool\",\"value\":false,\"stamp\":\"2021-06-10T11:43:51,757+02:00\",\"state\":\"ok\"})"
         ]
        }
       }
      }
     }
    },
    "requestBody": {
     "description": "Data points in v2 format.",
     "content": {
      "application/jsonl; charset=utf-8": {
       "schema": {
        "$ref": "#/components/schemas/ExportDataPointV2Line"
       },
       "example": "{\"path\":\"EXMPL1:Room1:Temp:GW_Lo:PLC:Station\",\"type\":\"int\",\"value\":1,\"stamp\":\"2021-06-10T13:34:17,679+02:00\",\"state\":\"ok\"}\n{\"path\":\"EXMPL1:Room1:Temp:GW_Lo:PLC:Telegram\",\"type\":\"int\",\"value\":101,\"stamp\":\"2021-06-10T13:34:17,679+02:00\",\"state\":\"ok\"}\n"
      }
     }
    }
   }
  },
  "/export/v1": {
   "get": {
    "tags": [
     "Import / Export"
    ],
    "summary": "Export data points (v1 format).",
    "description": "Only for ProMoS NG. Exports data points as a file (HTTP(S) GET).\n\nFormats:\n\n- **v1**: traditional ProMoS NT storage format, always ISO 8859-1 (Latin1) encoded CSV without header; fields `path;type;value;readwriteFlag`. Restriction: time stamp and state are not present.\n- **v2**: JSON Lines (https://jsonlines.org/), always UTF-8; one object per line with `path`, `type`, `value`, `stamp`, `state` (see schema ExportDataPointV2Line).\n\nTo get the same content as stored by ProMoS DMS:\n\n| File | Request |\n|---|---|\n| ProMoS.dms | `/export/v1?excludeStartPath=BMO%3A` |\n| BMO.dms | `/export/v1?path=BMO&pathPrefix=BMO` |\n\nIn case of a fatal error any HTTP status code (like 400, 404, 405...) is returned. On a valid request HTTP 200 with the file is returned.",
    "parameters": [
     {
      "name": "path",
      "in": "query",
      "required": false,
      "description": "The start path for the export. Default: empty (root path).",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "excludeStartPath",
      "in": "query",
      "required": false,
      "description": "Any path starting with this value is not exported.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "pathPrefix",
      "in": "query",
      "required": false,
      "description": "Any exported RDS will have this value as prefix RDS part.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "includeReadonly",
      "in": "query",
      "required": false,
      "description": "\"true\", \"t\" or \"1\" will also export read-only data points (mostly used internally by the system). Default: 0.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "hasRefs",
      "in": "query",
      "required": false,
      "description": "Reference id(s) to export, multiple ids separated by \",\". For reference ids see the nodeReferences command.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "filename",
      "in": "query",
      "required": false,
      "description": "The file name to be used in the response. Default: \"export.csv\".",
      "schema": {
       "type": "string",
       "default": "export.csv"
      }
     },
     {
      "name": "onlyChilds",
      "in": "query",
      "required": false,
      "description": "If true, only child data points of the data point being exported are included. Default: false.",
      "schema": {
       "type": "boolean",
       "default": false
      }
     }
    ],
    "responses": {
     "200": {
      "description": "Exported data point file.",
      "content": {
       "text/csv; charset=ISO-8859-1": {
        "schema": {
         "type": "string"
        },
        "example": "EXMPL1:Room1:Temp:GW_Lo:PLC:Station;DWS;1;RW\nEXMPL1:Room1:Temp:GW_Lo:PLC:Telegram;DWS;101;RW\n"
       }
      }
     }
    }
   }
  },
  "/export/v2": {
   "get": {
    "tags": [
     "Import / Export"
    ],
    "summary": "Export data points (v2 format).",
    "description": "Only for ProMoS NG. Exports data points as a file (HTTP(S) GET).\n\nFormats:\n\n- **v1**: traditional ProMoS NT storage format, always ISO 8859-1 (Latin1) encoded CSV without header; fields `path;type;value;readwriteFlag`. Restriction: time stamp and state are not present.\n- **v2**: JSON Lines (https://jsonlines.org/), always UTF-8; one object per line with `path`, `type`, `value`, `stamp`, `state` (see schema ExportDataPointV2Line).\n\nIn case of a fatal error any HTTP status code (like 400, 404, 405...) is returned. On a valid request HTTP 200 with the file is returned.",
    "parameters": [
     {
      "name": "path",
      "in": "query",
      "required": false,
      "description": "The start path for the export. Default: empty (root path).",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "excludeStartPath",
      "in": "query",
      "required": false,
      "description": "Any path starting with this value is not exported.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "pathPrefix",
      "in": "query",
      "required": false,
      "description": "Any exported RDS will have this value as prefix RDS part.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "includeReadonly",
      "in": "query",
      "required": false,
      "description": "\"true\", \"t\" or \"1\" will also export read-only data points (mostly used internally by the system). Default: 0.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "hasRefs",
      "in": "query",
      "required": false,
      "description": "Reference id(s) to export, multiple ids separated by \",\". For reference ids see the nodeReferences command.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "filename",
      "in": "query",
      "required": false,
      "description": "The file name to be used in the response. Default: \"export.jsonl\".",
      "schema": {
       "type": "string",
       "default": "export.jsonl"
      }
     },
     {
      "name": "onlyChilds",
      "in": "query",
      "required": false,
      "description": "If true, only child data points of the data point being exported are included. Default: false.",
      "schema": {
       "type": "boolean",
       "default": false
      }
     }
    ],
    "responses": {
     "200": {
      "description": "Exported data point file.",
      "content": {
       "application/jsonl; charset=utf-8": {
        "schema": {
         "type": "string"
        },
        "example": "{\"path\":\"EXMPL1:Room1:Temp:GW_Lo:PLC:Station\",\"type\":\"int\",\"value\":1,\"stamp\":\"2021-06-10T13:34:17,679+02:00\",\"state\":\"ok\"}\n{\"path\":\"EXMPL1:Room1:Temp:GW_Lo:PLC:Telegram\",\"type\":\"int\",\"value\":101,\"stamp\":\"2021-06-10T13:34:17,679+02:00\",\"state\":\"ok\"}\n"
       }
      }
     }
    }
   }
  },
  "/historical_data_import/v1": {
   "put": {
    "tags": [
     "Import / Export"
    ],
    "summary": "Import historical data (CSV).",
    "description": "Only for ProMoS NG. Imports historical values sent as CSV in the request body (HTTP(S) PUT).\n\nMandatory: either the URL parameter `path`, or `columns` containing a `path` column that holds the data point path of each line.\n\nLines without error are imported; lines with errors are reported in `errors`. The import is aborted after a maximum of 100 errors.\n\n`timestampFormat` placeholders: see the table of the historical data export.\n\nIn case of a fatal error any HTTP status code (like 400, 404, 405...) is returned.",
    "parameters": [
     {
      "name": "path",
      "in": "query",
      "required": false,
      "description": "The path of the value data point (mandatory unless `columns` contains `path`).",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "createPath",
      "in": "query",
      "required": false,
      "description": "Create path when not existing: 0 = no, 1 = yes, only value path (last value of the import will be set), 2 = yes, additionally an inactive \"TRD\" configuration is set. Default: 2.",
      "schema": {
       "type": "integer",
       "enum": [
        0,
        1,
        2
       ],
       "default": 2
      }
     },
     {
      "name": "removeBeforeImport",
      "in": "query",
      "required": false,
      "description": "Remove existing data for the path(s): 0 = no, 1 = range (same as in import), 2 = all. Default: 0.",
      "schema": {
       "type": "integer",
       "enum": [
        0,
        1,
        2
       ],
       "default": 0
      }
     },
     {
      "name": "encoding",
      "in": "query",
      "required": false,
      "description": "Text encoding (UTF-8 or ISO-8859-1). Default: UTF-8.",
      "schema": {
       "type": "string",
       "enum": [
        "UTF-8",
        "ISO-8859-1"
       ],
       "default": "UTF-8"
      }
     },
     {
      "name": "fieldDelimiter",
      "in": "query",
      "required": false,
      "description": "Delimiter between CSV fields. Default: \";\".",
      "schema": {
       "type": "string",
       "default": ";"
      }
     },
     {
      "name": "textQualifier",
      "in": "query",
      "required": false,
      "description": "Marks where text is enclosed. Default: '\"'.",
      "schema": {
       "type": "string",
       "default": "\""
      }
     },
     {
      "name": "headerLines",
      "in": "query",
      "required": false,
      "description": "Count of header lines that will be ignored. Default: 0.",
      "schema": {
       "type": "integer",
       "default": 0
      }
     },
     {
      "name": "columns",
      "in": "query",
      "required": false,
      "description": "Column designations in the correct order, separated by ';'. Possible designations: timestamp, value, status, path. Default: \"timestamp;value\".",
      "schema": {
       "type": "string",
       "default": "timestamp;value"
      }
     },
     {
      "name": "timestampFormat",
      "in": "query",
      "required": false,
      "description": "X (Unix seconds), x (Unix milliseconds), ISODate, ISODateWithMs, RFC2822Date, TextDate or other textual formats with placeholders. Can be left empty so several formats are tested on the first time stamp (not recommended, not all formats are unambiguous). Default: X.",
      "schema": {
       "type": "string",
       "default": "X"
      }
     },
     {
      "name": "filterTimestampMin",
      "in": "query",
      "required": false,
      "description": "Filter out values earlier than the given value (ms since 1970-01-01). Can be used to reduce unwanted data from the past. Default: 1.",
      "schema": {
       "type": "integer",
       "default": 1
      }
     },
     {
      "name": "timeZone",
      "in": "query",
      "required": false,
      "description": "UTC, LocalTime or any valid TZ identifier, e.g. Europe/Zurich. Default: UTC.",
      "schema": {
       "type": "string",
       "default": "UTC"
      }
     },
     {
      "name": "factor",
      "in": "query",
      "required": false,
      "description": "Factor applied to imported values. Default: 1.",
      "schema": {
       "type": "number",
       "default": 1
      }
     },
     {
      "name": "statusMap",
      "in": "query",
      "required": false,
      "description": "Map to convert incoming status (when present). Target states: ok, startup, comErr, inv; \"Other\" maps all other values. Default: \"ok=ok;startup=startup;comErr=comErr;inv=inv;Other=inv\".",
      "schema": {
       "type": "string",
       "default": "ok=ok;startup=startup;comErr=comErr;inv=inv;Other=inv"
      }
     }
    ],
    "responses": {
     "200": {
      "description": "Import result (schema ImportHistDataResult).",
      "content": {
       "application/json": {
        "schema": {
         "type": "string"
        },
        "example": {
         "imported": 367294,
         "errors": []
        }
       }
      }
     }
    },
    "requestBody": {
     "description": "CSV data with the columns defined by `columns`.",
     "content": {
      "text/csv": {
       "schema": {
        "type": "string"
       },
       "example": "1651242600;0.498\n1651243500;0.512\n"
      }
     }
    }
   }
  },
  "/historical_data_export/v1": {
   "get": {
    "tags": [
     "Import / Export"
    ],
    "summary": "Export historical data of a data point (CSV).",
    "description": "Only for ProMoS NG. Exports historical data of one data point as a CSV file (HTTP(S) GET). The parameters `start`, `end`, `interpolateTemplate`, `interpolateMethod`, `interval`, `alignStartEndTimestamp` and `prospective` have the same meaning as in the historical data request (get-histData).\n\nTime stamp output formats (`timestampFormat`):\n\n| Expression | Output |\n|---|---|\n| d | Day without leading zero (1-31) |\n| dd | Day with leading zero (01-31) |\n| ddd | Abbreviated day name ('Mon'-'Sun') |\n| dddd | Long day name ('Monday'-'Sunday') |\n| M | Month without leading zero (1-12) |\n| MM | Month with leading zero (01-12) |\n| MMM | Abbreviated month name ('Jan'-'Dec') |\n| MMMM | Long month name ('January'-'December') |\n| yy | Two digit year (00-99) |\n| yyyy | Four digit year (negative years get a minus sign) |\n| h | Hour without leading zero (0-23 or 1-12 with AM/PM) |\n| hh | Hour with leading zero (00-23 or 01-12 with AM/PM) |\n| H | Hour without leading zero (0-23, even with AM/PM) |\n| HH | Hour with leading zero (00-23, even with AM/PM) |\n| m | Minute without leading zero (0-59) |\n| mm | Minute with leading zero (00-59) |\n| s | Second without leading zero (0-59) |\n| ss | Second with leading zero (00-59) |\n| z or zz | Fractional second without trailing zeroes |\n| zzz | Fractional second, millisecond precision (000-999) |\n| AP or A | AM/PM display |\n| ap or a | am/pm display |\n| t | Time zone abbreviation (e.g. \"CEST\"; not unique) |\n| tt | UTC offset without colon (e.g. \"+0200\") |\n| ttt | UTC offset with colon (e.g. \"+02:00\") |\n| tttt | Time zone name (e.g. \"Europe/Berlin\") |\n| X | Unix time stamp in seconds since 1970-01-01 UTC |\n| x | Unix time stamp in milliseconds since 1970-01-01 UTC |\n\nIn case of a fatal error any HTTP status code (like 400, 404, 405...) is returned. On a valid request HTTP 200 with the file is returned.",
    "parameters": [
     {
      "name": "path",
      "in": "query",
      "required": true,
      "description": "Path of the data point to export (required).",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "start",
      "in": "query",
      "required": false,
      "description": "Start time stamp, as in the historical data request. Default: first.",
      "schema": {
       "type": "string",
       "default": "first"
      }
     },
     {
      "name": "end",
      "in": "query",
      "required": false,
      "description": "End time stamp, as in the historical data request. Default: last.",
      "schema": {
       "type": "string",
       "default": "last"
      }
     },
     {
      "name": "interpolateTemplate",
      "in": "query",
      "required": false,
      "description": "Interpolation template name (see interpolateGetTemplates).",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "interpolateMethod",
      "in": "query",
      "required": false,
      "description": "Interpolation method, as in the historical data request. Default: prevNextLinearFill.",
      "schema": {
       "type": "string",
       "default": "prevNextLinearFill"
      }
     },
     {
      "name": "interval",
      "in": "query",
      "required": false,
      "description": "Interpolation interval in seconds, as in the historical data request. Default: 900.",
      "schema": {
       "type": "integer",
       "default": 900
      }
     },
     {
      "name": "alignStartEndTimestamp",
      "in": "query",
      "required": false,
      "description": "As in the historical data request. Default: 0.",
      "schema": {
       "type": "integer",
       "default": 0
      }
     },
     {
      "name": "prospective",
      "in": "query",
      "required": false,
      "description": "As in the historical data request. Default: 0.",
      "schema": {
       "type": "integer",
       "default": 0
      }
     },
     {
      "name": "addState",
      "in": "query",
      "required": false,
      "description": "1 adds a state column (and \"State\" in the default header). Values: \"ok\", \"startup\", \"comErr\" or \"inv\". Default: 0.",
      "schema": {
       "type": "integer",
       "enum": [
        0,
        1
       ],
       "default": 0
      }
     },
     {
      "name": "addStorageReason",
      "in": "query",
      "required": false,
      "description": "1 adds a storage reason column (and \"StorageReason\" in the default header). Values: empty, \"cycle\", \"change\", \"diff\" or \"unknown\". Default: 0.",
      "schema": {
       "type": "integer",
       "enum": [
        0,
        1
       ],
       "default": 0
      }
     },
     {
      "name": "headerLine",
      "in": "query",
      "required": false,
      "description": "Custom header line. Default: Timestamp;Value.",
      "schema": {
       "type": "string",
       "default": "Timestamp;Value"
      }
     },
     {
      "name": "fieldDelimiter",
      "in": "query",
      "required": false,
      "description": "Delimiter for CSV fields. Default: \";\".",
      "schema": {
       "type": "string",
       "default": ";"
      }
     },
     {
      "name": "textQualifier",
      "in": "query",
      "required": false,
      "description": "Text qualifier. Default: '\"'.",
      "schema": {
       "type": "string",
       "default": "\""
      }
     },
     {
      "name": "endOfLine",
      "in": "query",
      "required": false,
      "description": "End of line character(s). Default: \\r\\n (CR/LF).",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "timeZone",
      "in": "query",
      "required": false,
      "description": "UTC, LocalTime or any valid TZ identifier, e.g. Europe/Zurich. Default: UTC.",
      "schema": {
       "type": "string",
       "default": "UTC"
      }
     },
     {
      "name": "timestampFormat",
      "in": "query",
      "required": false,
      "description": "Time stamp output format (see table in the description). Default: yyyy-MM-ddTHH:mm:ss.zzzttt (ISO 8601).",
      "schema": {
       "type": "string",
       "default": "yyyy-MM-ddTHH:mm:ss.zzzttt"
      }
     },
     {
      "name": "decimalPoint",
      "in": "query",
      "required": false,
      "description": "Decimal point for values (e.g. . or ,). Default: \".\".",
      "schema": {
       "type": "string",
       "default": "."
      }
     },
     {
      "name": "decimals",
      "in": "query",
      "required": false,
      "description": "Number of decimals for the values. Default: 3.",
      "schema": {
       "type": "integer",
       "default": 3
      }
     },
     {
      "name": "encoding",
      "in": "query",
      "required": false,
      "description": "Data encoding, UTF-8 or ISO-8859-1. Default: UTF-8.",
      "schema": {
       "type": "string",
       "enum": [
        "UTF-8",
        "ISO-8859-1"
       ],
       "default": "UTF-8"
      }
     },
     {
      "name": "filename",
      "in": "query",
      "required": false,
      "description": "File name for the exported data. Default: DataExport_{path}_{yyyyMMddHHmmss}.csv.",
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "200": {
      "description": "CSV file. Example request: `/historical_data_export/v1?path=EXMPL1%3AMeter1%3ACurrent%20I%20L1`.",
      "content": {
       "text/csv": {
        "schema": {
         "type": "string"
        },
        "example": "\"Timestamp\";\"Value\"\n2022-04-29T14:30:00.000+00:00;0.498\n2022-04-29T14:45:00.000+00:00;0.512\n2022-04-29T15:00:00.000+00:00;0.670\n"
       }
      }
     }
    }
   }
  },
  "/changelog_export/v1": {
   "get": {
    "tags": [
     "Import / Export"
    ],
    "summary": "Export change logs (CSV).",
    "description": "Only for ProMoS NG. Exports change log entries as a CSV file (HTTP(S) GET). `start`/`end` as in the historical data request. Time stamp format placeholders: see the table of `/historical_data_export/v1`.\n\nResponse columns:\n\n| Column | Description |\n|---|---|\n| Timestamp | Formatted by URL parameter \"timestampFormat\" |\n| Path | DMS RDS |\n| User | User identity when present |\n| OldValue | |\n| NewValue | |\n| Text | Formatted by URL parameter \"format\" |\n| SiteGroup | |\n| Group | Change log group like \"Manip1\" |\n\nNote: the Text column refers to a URL parameter \"format\" which is not listed in this endpoint's parameter table (it is listed for the alarm export).\n\nIn case of a fatal error any HTTP status code (like 400, 404, 405...) is returned. On a valid request HTTP 200 with the file is returned.",
    "parameters": [
     {
      "name": "start",
      "in": "query",
      "required": false,
      "description": "Start time stamp. Default: first.",
      "schema": {
       "type": "string",
       "default": "first"
      }
     },
     {
      "name": "end",
      "in": "query",
      "required": false,
      "description": "End time stamp. Default: last.",
      "schema": {
       "type": "string",
       "default": "last"
      }
     },
     {
      "name": "filter_path",
      "in": "query",
      "required": false,
      "description": "Path to filter - partial match.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "filter_exactPath",
      "in": "query",
      "required": false,
      "description": "Path to filter - exact match.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "filter_text",
      "in": "query",
      "required": false,
      "description": "Text to filter - partial match.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "filter_user",
      "in": "query",
      "required": false,
      "description": "User entry - partial match.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "filter_siteGroup",
      "in": "query",
      "required": false,
      "description": "One or more site group numbers, separated by \",\".",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "filter_group",
      "in": "query",
      "required": false,
      "description": "Group name of the change log to export - see changelogGetGroups.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "fieldDelimiter",
      "in": "query",
      "required": false,
      "description": "Delimiter for CSV fields. Default: \";\".",
      "schema": {
       "type": "string",
       "default": ";"
      }
     },
     {
      "name": "textQualifier",
      "in": "query",
      "required": false,
      "description": "Text qualifier. Default: '\"'.",
      "schema": {
       "type": "string",
       "default": "\""
      }
     },
     {
      "name": "endOfLine",
      "in": "query",
      "required": false,
      "description": "End of line character(s). Default: \\r\\n (CR/LF).",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "timeZone",
      "in": "query",
      "required": false,
      "description": "UTC, LocalTime or any valid TZ identifier, e.g. Europe/Zurich. Default: UTC.",
      "schema": {
       "type": "string",
       "default": "UTC"
      }
     },
     {
      "name": "timestampFormat",
      "in": "query",
      "required": false,
      "description": "Time stamp output format (see table in the description). Default: yyyy-MM-ddTHH:mm:ss.zzzttt (ISO 8601).",
      "schema": {
       "type": "string",
       "default": "yyyy-MM-ddTHH:mm:ss.zzzttt"
      }
     },
     {
      "name": "decimalPoint",
      "in": "query",
      "required": false,
      "description": "Decimal point for values (e.g. . or ,). Default: \".\".",
      "schema": {
       "type": "string",
       "default": "."
      }
     },
     {
      "name": "decimals",
      "in": "query",
      "required": false,
      "description": "Number of decimals for the values. Default: 3.",
      "schema": {
       "type": "integer",
       "default": 3
      }
     },
     {
      "name": "encoding",
      "in": "query",
      "required": false,
      "description": "Data encoding, UTF-8 or ISO-8859-1. Default: UTF-8.",
      "schema": {
       "type": "string",
       "enum": [
        "UTF-8",
        "ISO-8859-1"
       ],
       "default": "UTF-8"
      }
     },
     {
      "name": "filename",
      "in": "query",
      "required": false,
      "description": "File name for the exported data. Default: ChangelogExport_{yyyyMMddHHmmss}.csv.",
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "200": {
      "description": "CSV file with the change log entries.",
      "content": {
       "text/csv": {
        "schema": {
         "type": "string"
        },
        "example": "\"Timestamp\";\"Path\";\"User\";\"OldValue\";\"NewValue\";\"Text\";\"SiteGroup\";\"Group\"\n\"2023-09-06T06:47:47.369+00:00\";\"EXMPL1:MBus:Bus005:ComBus:Enabled\";\"operator\";\"0\";\"1\";\"MBus Bus005 / On\";0;\"Manip1\"\n"
       }
      }
     }
    }
   }
  },
  "/alarm_export/v1": {
   "get": {
    "tags": [
     "Import / Export"
    ],
    "summary": "Export alarms (CSV).",
    "description": "Only for ProMoS NG. Exports alarms as a CSV file (HTTP(S) GET). `start`/`end` as in the historical data request. Time stamp format placeholders: see the table of `/historical_data_export/v1`.\n\nResponse columns:\n\n| Column | Description |\n|---|---|\n| Timestamp | Formatted by URL parameter \"timestampFormat\" |\n| Path | DMS RDS |\n| User | User identity for acknowledged alarm |\n| OldValue | |\n| NewValue | |\n| Text | Formatted by URL parameter \"format\" |\n| SiteGroup | |\n| Group | Typically \"Alarm\" or \"Service\" |\n| IsPending | 0 or 1, 1 for pending alarm |\n| AlarmCfgNr | Integer, alarm configuration \"Alarmx\" |\n| State | \"unknown\", \"occurred\", \"acknowledged\", \"left\", \"leftAcknowledged\" |\n| Priority | |\n| PriorityDevice | |\n| AlarmGroup | |\n| AlarmCollectGroup | |\n\nIn case of a fatal error any HTTP status code (like 400, 404, 405...) is returned. On a valid request HTTP 200 with the file is returned.",
    "parameters": [
     {
      "name": "start",
      "in": "query",
      "required": false,
      "description": "Start time stamp. Default: first.",
      "schema": {
       "type": "string",
       "default": "first"
      }
     },
     {
      "name": "end",
      "in": "query",
      "required": false,
      "description": "End time stamp. Default: last.",
      "schema": {
       "type": "string",
       "default": "last"
      }
     },
     {
      "name": "filter_isPending",
      "in": "query",
      "required": false,
      "description": "0 (false) or 1 (true): send pending alarms - default is true.",
      "schema": {
       "type": "integer",
       "enum": [
        0,
        1
       ]
      }
     },
     {
      "name": "filter_isHistorical",
      "in": "query",
      "required": false,
      "description": "0 (false) or 1 (true): send historical alarms - default is false.",
      "schema": {
       "type": "integer",
       "enum": [
        0,
        1
       ]
      }
     },
     {
      "name": "filter_group",
      "in": "query",
      "required": false,
      "description": "Group name of the alarms to export - see alarmGetGroups.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "filter_path",
      "in": "query",
      "required": false,
      "description": "Path to filter - partial match.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "filter_exactPath",
      "in": "query",
      "required": false,
      "description": "Path to filter - exact match.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "filter_state",
      "in": "query",
      "required": false,
      "description": "One or more states separated by \",\": \"occurred\", \"acknowledged\", \"left\", \"leftAcknowledged\".",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "filter_text",
      "in": "query",
      "required": false,
      "description": "Text to filter - partial match.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "filter_user",
      "in": "query",
      "required": false,
      "description": "User entry - partial match.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "filter_alarmCfgNr",
      "in": "query",
      "required": false,
      "description": "One or more alarm configuration numbers (\"AlarmX\"), separated by \",\".",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "filter_priority",
      "in": "query",
      "required": false,
      "description": "One or more priorities, separated by \",\".",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "filter_alarmGroup",
      "in": "query",
      "required": false,
      "description": "One or more alarm groups (numbers), separated by \",\".",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "filter_alarmCollectGroup",
      "in": "query",
      "required": false,
      "description": "One or more alarm collective groups, separated by \",\".",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "filter_siteGroup",
      "in": "query",
      "required": false,
      "description": "One or more site groups, separated by \",\".",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "format",
      "in": "query",
      "required": false,
      "description": "Other format for the \"Text\" column than default - see ProMoS documentation, formats like \"#c / #N / #V^NAME / #z(Ein:Aus) / #u\".",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "locale",
      "in": "query",
      "required": false,
      "description": "Locale in the format \"{language lowercase, ISO 639}_{country, ISO 3166}\", e.g. \"de_CH\".",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "fieldDelimiter",
      "in": "query",
      "required": false,
      "description": "Delimiter for CSV fields. Default: \";\".",
      "schema": {
       "type": "string",
       "default": ";"
      }
     },
     {
      "name": "textQualifier",
      "in": "query",
      "required": false,
      "description": "Text qualifier. Default: '\"'.",
      "schema": {
       "type": "string",
       "default": "\""
      }
     },
     {
      "name": "endOfLine",
      "in": "query",
      "required": false,
      "description": "End of line character(s). Default: \\r\\n (CR/LF).",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "timeZone",
      "in": "query",
      "required": false,
      "description": "UTC, LocalTime or any valid TZ identifier, e.g. Europe/Zurich. Default: UTC.",
      "schema": {
       "type": "string",
       "default": "UTC"
      }
     },
     {
      "name": "timestampFormat",
      "in": "query",
      "required": false,
      "description": "Time stamp output format (see table in the description). Default: yyyy-MM-ddTHH:mm:ss.zzzttt (ISO 8601).",
      "schema": {
       "type": "string",
       "default": "yyyy-MM-ddTHH:mm:ss.zzzttt"
      }
     },
     {
      "name": "decimalPoint",
      "in": "query",
      "required": false,
      "description": "Decimal point for values (e.g. . or ,). Default: \".\".",
      "schema": {
       "type": "string",
       "default": "."
      }
     },
     {
      "name": "decimals",
      "in": "query",
      "required": false,
      "description": "Number of decimals for the values. Default: 3.",
      "schema": {
       "type": "integer",
       "default": 3
      }
     },
     {
      "name": "encoding",
      "in": "query",
      "required": false,
      "description": "Data encoding, UTF-8 or ISO-8859-1. Default: UTF-8.",
      "schema": {
       "type": "string",
       "enum": [
        "UTF-8",
        "ISO-8859-1"
       ],
       "default": "UTF-8"
      }
     },
     {
      "name": "filename",
      "in": "query",
      "required": false,
      "description": "File name for the exported data. Default: AlarmExport_{yyyyMMddHHmmss}.csv.",
      "schema": {
       "type": "string"
      }
     }
    ],
    "responses": {
     "200": {
      "description": "CSV file with the alarms.",
      "content": {
       "text/csv": {
        "schema": {
         "type": "string"
        },
        "example": "\"Timestamp\";\"Path\";\"User\";\"OldValue\";\"NewValue\";\"Text\";\"SiteGroup\";\"Group\";\"IsPending\";\"AlarmCfgNr\";\"State\";\"Priority\";\"PriorityDevice\";\"AlarmGroup\";\"AlarmCollectGroup\"\n\"2024-05-30T15:27:23.228+00:00\";\"EXMPL1:MBus:001:ComDev:ErrCom\";\"\";\"0\";\"1\";\"MBus Bus001, Adr001 communication error\";0;\"Alarm\";1;1;\"occurred\";2;0;998;0\n"
       }
      }
     }
    }
   }
  }
 },
 "components": {
  "schemas": {
   "Timestamp": {
    "type": "string",
    "description": "ISO 8601 formatted time stamp, e.g. \"2015-03-20T07:49:19,000+01:00\" or \"2015-04-04T00:00:00Z\" (see Timestamps).",
    "example": "2015-03-20T07:49:19,000+01:00"
   },
   "ValueType": {
    "type": "string",
    "enum": [
     "int",
     "double",
     "string",
     "bool",
     "none"
    ],
    "description": "Value type: \"int\", \"double\" (floating point number), \"string\", \"bool\" or \"none\" for nodes without value."
   },
   "WriteValueType": {
    "type": "string",
    "enum": [
     "int",
     "double",
     "string",
     "bool",
     "none",
     "int8",
     "uint8",
     "int16",
     "uint16",
     "int32",
     "uint32",
     "double64"
    ],
    "description": "Value type for write/create operations. \"int\", \"double\", \"string\", \"bool\" or \"none\". For more accurate type definitions in older ProMoS systems \"int8\", \"uint8\", \"int16\", \"uint16\", \"int32\", \"uint32\" or \"double64\" can be set. \"int\" means \"int32\" for ProMoS NT and \"int64\" for ProMoS NG."
   },
   "DataPointValue": {
    "description": "A data point value: number, boolean, string or null.",
    "nullable": true,
    "oneOf": [
     {
      "type": "number"
     },
     {
      "type": "boolean"
     },
     {
      "type": "string"
     }
    ]
   },
   "Tag": {
    "description": "Any JSON data (object, array, number, string, boolean); echoed unchanged in the response (and in events for subscriptions)."
   },
   "PcfError": {
    "type": "object",
    "description": "Only ProMoS NG. Process control function error entry.",
    "x-ngOnly": true,
    "properties": {
     "targetNode": {
      "type": "string",
      "description": "Path of the node the process control function belongs to."
     },
     "msg": {
      "type": "string",
      "description": "Error message, e.g. \"Division by zero ...\"."
     },
     "id": {
      "type": "string",
      "description": "Identifier of the process control function, e.g. \"PRG\"."
     }
    }
   },
   "NodeRef": {
    "type": "object",
    "description": "A node reference: reference id with value. For the list of reference ids see Node reference ids.",
    "properties": {
     "id": {
      "type": "number",
      "description": "Reference id."
     },
     "value": {
      "description": "Value of the reference; any JSON type (boolean, number, string, object, array)."
     }
    },
    "required": [
     "id"
    ]
   },
   "RefsQueryEntry": {
    "type": "object",
    "description": "Only ProMoS NG. Reference filter entry {\"id\": number, \"value\": regex/string/double/bool/int}. Only \"id\" or only \"value\" can be used as well.",
    "x-ngOnly": true,
    "properties": {
     "id": {
      "type": "number",
      "description": "Reference id."
     },
     "value": {
      "description": "Value to match: regex string, string, double, bool or int."
     }
    }
   },
   "ChildQuery": {
    "type": "object",
    "description": "Query for child nodes (element of query.childs). All child query objects are AND linked.",
    "properties": {
     "pathPart": {
      "type": "string",
      "description": "The requested child path part."
     },
     "value": {
      "description": "Any value to compare. For \"in\" / \"nin\" the value can be a string with multiple values separated by \"|\" or an array with mixed values."
     },
     "valueCompare": {
      "type": "string",
      "description": "Compare algorithm. Default is \"eq\". \"jse\" (JSEngine) is only available on ProMoS NG.",
      "enum": [
       "eq",
       "neq",
       "lt",
       "lte",
       "gt",
       "gte",
       "in",
       "nin",
       "startsWith",
       "endsWith",
       "contains",
       "regex",
       "jse"
      ],
      "default": "eq"
     },
     "global": {
      "type": "boolean",
      "description": "If true, \"pathPart\" is searched not only in child nodes but also in parent nodes (until it is found or the root is reached)."
     },
     "return": {
      "type": "boolean",
      "description": "If true, this found data point is returned. Multiple entries can have \"return\": true. When no object has \"return\": true, the root data point is returned when found."
     }
    },
    "required": [
     "pathPart"
    ]
   },
   "GetQuery": {
    "type": "object",
    "description": "Query object to search data point paths and values, starting at the request \"path\". RegEx patterns use Perl 5 syntax (PCRE 8.43), extended patterns are supported. A query resulting in more than 150'000 data points is aborted with an error; use limit/offset.",
    "properties": {
     "regExPath": {
      "type": "string",
      "description": "RegEx pattern for the path. Default is none (empty)."
     },
     "regExValue": {
      "type": "string",
      "description": "RegEx pattern for the value. Default is none (empty). To be sure to find the correct value (e.g. bool true) combine with \"isType\"."
     },
     "regExStamp": {
      "type": "string",
      "description": "RegEx pattern for the time stamp. Default is none (empty). The searched time stamp is composed as described in Timestamps."
     },
     "childs": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/ChildQuery"
      },
      "description": "Array of query objects for querying child nodes. All object definitions are AND linked."
     },
     "isType": {
      "type": "string",
      "description": "Comma separated list of searched types (\"none\", \"bool\", \"int\", \"double\", \"string\"), e.g. \"int,double\". Default is all types."
     },
     "isNotReadonly": {
      "type": "boolean",
      "description": "Only ProMoS NG. Filter for data points that are not read only. Default is false.",
      "default": false,
      "x-ngOnly": true
     },
     "hasHistData": {
      "type": "boolean",
      "description": "Filter for data points with historical data recording. Default is false.",
      "default": false
     },
     "hasChangelog": {
      "type": "boolean",
      "description": "Filter for data points with change log. Default is false.",
      "default": false
     },
     "hasAlarmData": {
      "type": "boolean",
      "description": "Filter for data points with alarm data / data recording. Default is false.",
      "default": false
     },
     "hasProcessControlFunction": {
      "type": "boolean",
      "description": "Only ProMoS NG. Filter for data points with process control function. Default is false.",
      "default": false,
      "x-ngOnly": true
     },
     "hasNoProcessControlFunction": {
      "type": "boolean",
      "description": "Only ProMoS NG. Filter for data points with no process control function. Default is false.",
      "default": false,
      "x-ngOnly": true
     },
     "hasProcessControlFunctionError": {
      "type": "boolean",
      "description": "Only ProMoS NG. Filter for data points with one or more process control function error(s). Default is false.",
      "default": false,
      "x-ngOnly": true
     },
     "hasRefs": {
      "description": "Only ProMoS NG. Number or array of numbers with reference ids.",
      "x-ngOnly": true,
      "oneOf": [
       {
        "type": "number"
       },
       {
        "type": "array",
        "items": {
         "type": "number"
        }
       }
      ]
     },
     "regExRefValue": {
      "type": "string",
      "description": "RegEx pattern for the reference value. Default is none (empty). Combine with \"hasRefs\" to find the correct value."
     },
     "hasRefsQuery": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/RefsQueryEntry"
      },
      "description": "Only ProMoS NG. If a node has refs, they are filtered according to the provided entries. \"hasRefs\" and/or \"regExRefValue\" are not required. Entries are combined as logical OR - the first matching entry is returned.",
      "x-ngOnly": true
     },
     "hasParentRefsQuery": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/RefsQueryEntry"
      },
      "description": "Only ProMoS NG. Like hasRefsQuery, but matches if a parent node (up to the root) of the node has refs matching the entries. Entries are combined as logical OR.",
      "x-ngOnly": true
     },
     "maxDepth": {
      "type": "number",
      "description": "Maximal depth for searching paths recursively. Default is 1 (current path). 0 means no restriction, all sub paths are searched.",
      "default": 1
     },
     "limit": {
      "type": "number",
      "description": "Maximum number of records to send. Default is the internal maximum. When reached, the last record of the response is a limitReached object. Only ProMoS NG.",
      "x-ngOnly": true
     },
     "offset": {
      "description": "Offset from where the records should begin: a number or a string with the starting path. Default is 0. Only ProMoS NG.",
      "x-ngOnly": true,
      "oneOf": [
       {
        "type": "number"
       },
       {
        "type": "string"
       }
      ]
     }
    }
   },
   "FilterParam": {
    "type": "object",
    "x-ngOnly": true,
    "description": "Only ProMoS NG. Filter for data ranges used in the historical data calculation. All filter objects are OR conjunctions.",
    "properties": {
     "timeStart": {
      "type": "string",
      "description": "Start time of day for the filter duration (ISO time, e.g. \"22:00:00\")."
     },
     "duration": {
      "type": "integer",
      "description": "Duration in seconds from \"timeStart\"."
     },
     "weekDays": {
      "type": "array",
      "items": {
       "type": "integer",
       "minimum": 1,
       "maximum": 7
      },
      "description": "Timestamp is on one of these days of week (1=Monday ... 7=Sunday). Empty means no filter."
     },
     "months": {
      "type": "array",
      "items": {
       "type": "integer"
      },
      "description": "Timestamp is in one of these months. Empty means no filter."
     },
     "valueCompare": {
      "type": "string",
      "description": "Compare logic.",
      "enum": [
       "eq",
       "neq",
       "lt",
       "lte",
       "gt",
       "gte"
      ]
     },
     "value": {
      "type": "number",
      "description": "Value to compare with (double)."
     }
    }
   },
   "NormalizeParam": {
    "type": "object",
    "x-ngOnly": true,
    "description": "Only ProMoS NG. Normalization step executed before the final interpolation. Any diff... is executed first. Normalization is only executed when its interval is lower or equal to the next interval.",
    "properties": {
     "method": {
      "type": "string",
      "description": "Interpolation method, see histData.interpolateMethod."
     },
     "interval": {
      "description": "Interval, see histData.interval. Example: 900.",
      "oneOf": [
       {
        "type": "number"
       },
       {
        "type": "string"
       }
      ]
     },
     "alignStartEndTimestamp": {
      "type": "boolean",
      "description": "See histData.alignStartEndTimestamp."
     },
     "offsetMinFromUTC": {
      "type": "number",
      "description": "See histData.offsetMinFromUTC."
     },
     "filterParams": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/FilterParam"
      },
      "description": "See histData.filterParams."
     }
    }
   },
   "HistDataRequest": {
    "type": "object",
    "description": "Definitions for requesting historical data. The resulting histData array is limited to max. 610'000 entries.",
    "properties": {
     "start": {
      "type": "string",
      "description": "Requested start time stamp (ISO 8601). Only ProMoS NG: can also be \"first\", \"last\" or \"now\"."
     },
     "end": {
      "type": "string",
      "description": "Requested end time stamp (ISO 8601). Default is the current time stamp. Only ProMoS NG: can also be \"first\", \"last\" or \"now\"."
     },
     "interpolateTemplate": {
      "type": "string",
      "description": "Only ProMoS NG. Name of an interpolate parameters template (see interpolateGetTemplates). Values present in the template set interpolateMethod / interval / filterParams / normalizeParams. Other values sent in this request overwrite these, unless the template name is prefixed with '!'.",
      "x-ngOnly": true
     },
     "interpolateMethod": {
      "type": "string",
      "description": "Only ProMoS NG. Interpolation method plus optional parameters, case insensitive, e.g. \"prevNextLinearFill\", \"sumLinearFill\", \"minMaxAlignFillAverage\", \"diffSumLinearFill\" (see command description). Default (empty) is \"prevNextLinearFill\".",
      "x-ngOnly": true
     },
     "interval": {
      "type": "number",
      "description": "Interval of requested data in seconds. Default is 900 (15 minutes). 0 means all recorded raw values, not interpolated. Only ProMoS NG special intervals: -1 daily, -2 weekly, -3 monthly, -4 quarterly, -5 half yearly, -6 yearly.",
      "default": 900
     },
     "alignStartEndTimestamp": {
      "type": "boolean",
      "description": "Align timestamps to interval duration. Default is false.",
      "default": false
     },
     "offsetMinFromUTC": {
      "type": "number",
      "description": "Offset in minutes from UTC (e.g. 120 for CEST), used to align timestamps (e.g. daily). When not sent, the start timestamp is analyzed; if it contains a +/- timezone offset, this offset is used."
     },
     "filterParams": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/FilterParam"
      },
      "description": "Only ProMoS NG. Filters data ranges for the calculation results. All filter objects are OR conjunctions.",
      "x-ngOnly": true
     },
     "normalizeParams": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/NormalizeParam"
      },
      "description": "Only ProMoS NG. Normalize the data first, before the final interpolation.",
      "x-ngOnly": true
     },
     "prospective": {
      "type": "boolean",
      "description": "Only ProMoS NG. By default timestamps are sent in retrospective view; true sends them in prospective view (e.g. daily value at 2023-03-20T00:00 contains data of 2023-03-20 instead of 2023-03-19).",
      "default": false,
      "x-ngOnly": true
     },
     "format": {
      "type": "string",
      "description": "Response format. Default is \"compact\".",
      "enum": [
       "compact",
       "detail"
      ],
      "default": "compact"
     },
     "showPast": {
      "type": "boolean",
      "description": "Show value changes in the past (data changed or inserted in the range between start and end). Returned in an additional array \"histDataPast\" in the same format as \"histData\". Default false. Only available on ProMoS V2.x installations.",
      "default": false
     },
     "showOriginal": {
      "type": "boolean",
      "description": "Show original value when a value was changed. Default false. Adds \"valueOriginal\" to histData entries when data was changed (only with format \"detail\"). Can be time and memory sensitive.",
      "default": false
     },
     "limit": {
      "type": "number",
      "description": "Only ProMoS NG. Limits the result to the defined max entries. When reached, \"histDataLimitReached\": true is returned.",
      "x-ngOnly": true
     },
     "count": {
      "type": "boolean",
      "description": "Only ProMoS NG. True returns the count of records in \"histDataCount\". Default is false.",
      "default": false,
      "x-ngOnly": true
     }
    },
    "required": [
     "start"
    ]
   },
   "GetRequestItem": {
    "type": "object",
    "description": "One data point read definition. Either \"path\" or \"id\" is mandatory. In the short request variant, the array element is just the path string instead of this object.",
    "properties": {
     "path": {
      "type": "string",
      "description": "Path of the data point to read (mandatory, or id). For queries, the starting data point; \"\" is the DMS root. ProMoS NT 1.x/2.x only: array indexed strings like \"TEST:ARRAY[2]\" or \"TEST:ARRAY[2]BIT\" are supported."
     },
     "id": {
      "type": "string",
      "description": "Id of the data point to read (mandatory, or path)."
     },
     "showExtInfos": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "description": "Returns optional information like template, name, unit...."
     },
     "showChilds": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "description": "Only ProMoS NG. Returns additional child objects with the given path parts.",
      "x-ngOnly": true
     },
     "query": {
      "allOf": [
       {
        "$ref": "#/components/schemas/GetQuery"
       }
      ],
      "description": "Query object. Default is no query."
     },
     "histData": {
      "allOf": [
       {
        "$ref": "#/components/schemas/HistDataRequest"
       }
      ],
      "description": "Definitions for requesting historical data. Default is no histData."
     },
     "changelogRead": {
      "type": "array",
      "items": {
       "type": "object"
      },
      "description": "Embedded change log / alarm request (same definitions as the direct commands, see changelogRead, changelogCount, alarmRead and alarmCount). The get path is used as filter (can be overwritten in the \"filter\" object); for change logs \"group\" is optional and evaluated from the data point configuration when possible. Result limited to 100'000 entries."
     },
     "changelogCount": {
      "type": "array",
      "items": {
       "type": "object"
      },
      "description": "Embedded change log / alarm request (same definitions as the direct commands, see changelogRead, changelogCount, alarmRead and alarmCount). The get path is used as filter (can be overwritten in the \"filter\" object); for change logs \"group\" is optional and evaluated from the data point configuration when possible. Result limited to 100'000 entries."
     },
     "alarmRead": {
      "type": "array",
      "items": {
       "type": "object"
      },
      "description": "Embedded change log / alarm request (same definitions as the direct commands, see changelogRead, changelogCount, alarmRead and alarmCount). The get path is used as filter (can be overwritten in the \"filter\" object); for change logs \"group\" is optional and evaluated from the data point configuration when possible. Result limited to 100'000 entries."
     },
     "alarmCount": {
      "type": "array",
      "items": {
       "type": "object"
      },
      "description": "Embedded change log / alarm request (same definitions as the direct commands, see changelogRead, changelogCount, alarmRead and alarmCount). The get path is used as filter (can be overwritten in the \"filter\" object); for change logs \"group\" is optional and evaluated from the data point configuration when possible. Result limited to 100'000 entries."
     },
     "tag": {
      "allOf": [
       {
        "$ref": "#/components/schemas/Tag"
       }
      ],
      "description": "Any data that will be echoed in the response."
     }
    }
   },
   "GetShortRequestItem": {
    "type": "string",
    "description": "Short read request: the get array contains only data point path strings. The response looks like the normal response; the order of the response fields is not guaranteed."
   },
   "ExtInfosSubscriptionClient": {
    "type": "object",
    "description": "A client subscription on this data point.",
    "properties": {
     "tag": {
      "allOf": [
       {
        "$ref": "#/components/schemas/Tag"
       }
      ],
      "description": "Tag data from request. Present when existing in the request."
     },
     "whois": {
      "type": "string",
      "description": "Identification of the subscribing client."
     },
     "host": {
      "type": "string",
      "description": "Host of the subscribing client."
     },
     "events": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "description": "Subscribed events, e.g. [\"onChange\", \"onDelete\"]."
     }
    }
   },
   "ExtInfosSubscriptionPcf": {
    "type": "object",
    "description": "A process control function depending on this data point.",
    "properties": {
     "path": {
      "type": "string",
      "description": "Path of the process control function's data point."
     },
     "function": {
      "type": "string",
      "description": "Function name, e.g. \"EQU\"."
     }
    }
   },
   "ExtInfosSubscriptions": {
    "type": "object",
    "description": "Detailed subscription information for a data point.",
    "properties": {
     "clients": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/ExtInfosSubscriptionClient"
      },
      "description": "Subscribed clients."
     },
     "processControls": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/ExtInfosSubscriptionPcf"
      },
      "description": "Process controls subscribed to this data point."
     }
    }
   },
   "ExtInfos": {
    "type": "object",
    "description": "Extended information for a data point (returned when showExtInfos was requested).",
    "properties": {
     "state": {
      "type": "string",
      "description": "Current state of the value: \"ok\", \"error\" (e.g. communication error to the end device), \"noData\" or \"pcfError\". Always present.",
      "enum": [
       "ok",
       "error",
       "noData",
       "pcfError"
      ]
     },
     "accType": {
      "type": "string",
      "description": "Accurate type: \"int8\", \"uint8\", \"int16\", \"uint16\", \"int32\", \"uint32\", \"int64\" (only ProMoS NG), \"double64\", \"double\", \"string\", \"bool\" or \"none\" for nodes. Always present.",
      "enum": [
       "int8",
       "uint8",
       "int16",
       "uint16",
       "int32",
       "uint32",
       "int64",
       "double64",
       "double",
       "string",
       "bool",
       "none"
      ]
     },
     "subscriptions": {
      "allOf": [
       {
        "$ref": "#/components/schemas/ExtInfosSubscriptions"
       }
      ],
      "description": "Detailed subscription information for this data point. Always present."
     },
     "hasData": {
      "type": "array",
      "items": {
       "type": "string",
       "enum": [
        "hasHistData",
        "hasAlarmData",
        "hasChangelog"
       ]
      },
      "description": "Information about data recording: \"hasHistData\", \"hasAlarmData\", \"hasChangelog\" (only ProMoS NG). Always present."
     },
     "name": {
      "type": "string",
      "description": "For ProMoS 1/2: content of the topmost NAME data point of this tree. When existing."
     },
     "object": {
      "type": "string",
      "description": "For ProMoS 1/2: content of the topmost OBJECT data point of this tree. When existing."
     },
     "template": {
      "type": "string",
      "description": "The used template; for ProMoS 1/2 the content of the topmost OBJECT data point of this tree. When existing."
     },
     "unit": {
      "type": "string",
      "description": "Any present unit information. When existing."
     },
     "comment": {
      "type": "string",
      "description": "Any present comment. When existing."
     },
     "changelogGroup": {
      "type": "string",
      "description": "Group name for change log. When existing."
     },
     "alarmGroups": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "description": "Group names for alarms. When existing."
     },
     "childs": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "description": "Child path parts. When existing."
     }
    }
   },
   "HistDataCompactEntry": {
    "type": "object",
    "description": "Compact historical data record: an object with a single property named with the ISO 8601 time stamp and the value as number, e.g. {\"2015-04-03T04:33:20,000+02:00\": 0.95}. Values may be null with the FillNull interpolation parameter.",
    "additionalProperties": {
     "type": "number",
     "nullable": true
    },
    "minProperties": 1,
    "maxProperties": 1
   },
   "HistDataOriginalValue": {
    "type": "object",
    "x-ngOnly": true,
    "description": "Only ProMoS NG. Original value of a modified historical record.",
    "properties": {
     "stamp": {
      "allOf": [
       {
        "$ref": "#/components/schemas/Timestamp"
       }
      ],
      "description": "Time stamp when the value was modified."
     },
     "value": {
      "type": "number",
      "description": "Original value."
     }
    }
   },
   "HistDataDetailEntry": {
    "type": "object",
    "description": "Detailed historical data record (format \"detail\").",
    "properties": {
     "stamp": {
      "allOf": [
       {
        "$ref": "#/components/schemas/Timestamp"
       }
      ],
      "description": "Time stamp of the historic entry. Always present."
     },
     "value": {
      "type": "number",
      "description": "The historic value. Always present.",
      "nullable": true
     },
     "state": {
      "type": "string",
      "description": "State of the value: \"ok\", \"startup\" (system start), \"comErr\" (recorded during communication error) or \"inv\" (any other error situation). Always present.",
      "enum": [
       "ok",
       "startup",
       "comErr",
       "inv"
      ]
     },
     "rec": {
      "type": "string",
      "description": "Record reason. Always present.",
      "enum": [
       "cycle",
       "change",
       "diff",
       "unknown"
      ]
     },
     "mod": {
      "type": "string",
      "description": "Deprecated (only ProMoS NT). Modified flag: \"modified\" (value was modified) or \"past\" (value was set in the past). Not transmitted otherwise.",
      "enum": [
       "modified",
       "past"
      ],
      "deprecated": true
     },
     "stampModified": {
      "allOf": [
       {
        "$ref": "#/components/schemas/Timestamp"
       }
      ],
      "description": "Deprecated (only ProMoS NT). Time stamp when the value was modified (inserted in the past or changed). Only in histDataPast.",
      "deprecated": true
     },
     "valueOriginal": {
      "type": "number",
      "description": "Deprecated (only ProMoS NT). Original value before modification. Only when request option showOriginal is set.",
      "deprecated": true
     },
     "valuesOriginal": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/HistDataOriginalValue"
      },
      "description": "Only ProMoS NG. Original values with stamp (time of modification) and value. When requested.",
      "x-ngOnly": true
     },
     "isFirst": {
      "type": "boolean",
      "description": "Only ProMoS NG. Indicates the first possible record. Present when true.",
      "x-ngOnly": true
     },
     "isLast": {
      "type": "boolean",
      "description": "Only ProMoS NG. Indicates the last possible record. Present when true.",
      "x-ngOnly": true
     }
    }
   },
   "HistDataEntry": {
    "description": "Historical data record, compact or detail depending on the requested format.",
    "oneOf": [
     {
      "$ref": "#/components/schemas/HistDataCompactEntry"
     },
     {
      "$ref": "#/components/schemas/HistDataDetailEntry"
     }
    ]
   },
   "GetResponseItem": {
    "type": "object",
    "description": "Result for one requested data point (or query hit). With limit on a query, the last record is a limitReached object with code, message, limit and nextOffset.",
    "properties": {
     "code": {
      "type": "string",
      "enum": [
       "ok",
       "no perm",
       "not found",
       "error",
       "limitReached"
      ],
      "description": "Result code: \"ok\" on success, \"no perm\" not allowed to read, \"not found\" data point doesn't exist, \"error\" fatal error, \"limitReached\" (only ProMoS NG) query limit reached. Always present."
     },
     "path": {
      "type": "string",
      "description": "Path of the requested data point. Present when no fatal error."
     },
     "id": {
      "type": "string",
      "description": "Id of the requested data point. Present when no fatal error."
     },
     "value": {
      "description": "Value of the data point. Present on code \"ok\".",
      "nullable": true,
      "oneOf": [
       {
        "type": "number"
       },
       {
        "type": "boolean"
       },
       {
        "type": "string"
       }
      ]
     },
     "type": {
      "allOf": [
       {
        "$ref": "#/components/schemas/ValueType"
       }
      ],
      "description": "The type of the value: \"int\", \"double\" (a floating point number), \"string\", \"bool\" or \"none\" for nodes without value. Present on code \"ok\"."
     },
     "hasChild": {
      "type": "boolean",
      "description": "Indicates that the data point has one or more child data points. Present on code \"ok\" only when the node has children."
     },
     "stamp": {
      "allOf": [
       {
        "$ref": "#/components/schemas/Timestamp"
       }
      ],
      "description": "Time stamp of the last change of the value, ISO 8601 formatted. Can be null. Present on code \"ok\".",
      "nullable": true
     },
     "state": {
      "type": "string",
      "description": "Only ProMoS NG. Sent when the state of the value is not \"ok\"; can be \"error\", \"noData\" or \"pcfError\".",
      "enum": [
       "error",
       "noData",
       "pcfError"
      ],
      "x-ngOnly": true
     },
     "pcfErrors": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/PcfError"
      },
      "description": "Only ProMoS NG. Detailed information about process control function errors. Present on code \"ok\" when errors are pending.",
      "x-ngOnly": true
     },
     "readonly": {
      "type": "boolean",
      "description": "Only ProMoS NG. Sent as true when the data point is read only.",
      "x-ngOnly": true
     },
     "refs": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/NodeRef"
      },
      "description": "Array of node references. Present on code \"ok\"."
     },
     "extInfos": {
      "allOf": [
       {
        "$ref": "#/components/schemas/ExtInfos"
       }
      ],
      "description": "Extended information. Present on code \"ok\" when showExtInfos was requested."
     },
     "childs": {
      "type": "object",
      "description": "Additional child objects that match showChilds. Present on code \"ok\" when showChilds was requested."
     },
     "message": {
      "type": "string",
      "description": "Human readable error message in English. Present on codes other than \"ok\". For limitReached e.g. \"Chosen limit reached\" or \"Memory limit reached\"."
     },
     "histData": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/HistDataEntry"
      },
      "description": "Historical data records (compact or detail). Present on code \"ok\" when histData was requested. Max. 610'000 entries."
     },
     "histDataPast": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/HistDataEntry"
      },
      "description": "Value changes in the past (same format as histData). Present when histData.showPast was requested."
     },
     "histDataLimitReached": {
      "type": "boolean",
      "description": "Only ProMoS NG. True when histData.limit was reached.",
      "x-ngOnly": true
     },
     "histDataCount": {
      "type": "number",
      "description": "Only ProMoS NG. Count of records, when histData.count was requested.",
      "x-ngOnly": true
     },
     "changelogRead": {
      "type": "array",
      "items": {
       "type": "object"
      },
      "description": "Embedded change log read result, see changelogRead. Present on code \"ok\" when requested."
     },
     "changelogCount": {
      "type": "array",
      "items": {
       "type": "object"
      },
      "description": "Embedded change log counter result, see changelogCount. Present on code \"ok\" when requested."
     },
     "alarmRead": {
      "type": "array",
      "items": {
       "type": "object"
      },
      "description": "Embedded alarm read result, see alarmRead. Present on code \"ok\" when requested."
     },
     "alarmCount": {
      "type": "array",
      "items": {
       "type": "object"
      },
      "description": "Embedded alarm counter result, see alarmCount. Present on code \"ok\" when requested."
     },
     "limit": {
      "type": "number",
      "description": "Only ProMoS NG. In a limitReached record: number of sent records (can be lower than the chosen limit when the memory limit was reached).",
      "x-ngOnly": true
     },
     "nextOffset": {
      "description": "Only ProMoS NG. In a limitReached record: offset for the next request (number, or string with the next path, depending on the request offset).",
      "x-ngOnly": true,
      "oneOf": [
       {
        "type": "number"
       },
       {
        "type": "string"
       }
      ]
     },
     "tag": {
      "allOf": [
       {
        "$ref": "#/components/schemas/Tag"
       }
      ],
      "description": "Tag data from request. Present when existing in the request."
     }
    },
    "required": [
     "code"
    ]
   },
   "SetHistDataDetailEntry": {
    "type": "object",
    "description": "Detailed historical data record to write.",
    "properties": {
     "stamp": {
      "allOf": [
       {
        "$ref": "#/components/schemas/Timestamp"
       }
      ],
      "description": "Time stamp of the recorded value."
     },
     "value": {
      "type": "number",
      "description": "The value."
     },
     "state": {
      "type": "string",
      "description": "Recording state.",
      "enum": [
       "ok",
       "comErr",
       "inv"
      ]
     }
    }
   },
   "SetHistDataEntry": {
    "description": "Historical data record to write: compact ({\"<stamp>\": value}, state \"ok\" is used) or detailed; formats can be mixed in one array.",
    "oneOf": [
     {
      "$ref": "#/components/schemas/HistDataCompactEntry"
     },
     {
      "$ref": "#/components/schemas/SetHistDataDetailEntry"
     }
    ]
   },
   "SetRequestItem": {
    "type": "object",
    "description": "One data point write definition. Either \"path\" or \"id\" is mandatory. \"value\" is mandatory unless state / refs / histData is sent.",
    "properties": {
     "path": {
      "type": "string",
      "description": "Path of the data point to write (mandatory, or id). ProMoS NT 1.x/2.x only: array indexed strings like \"TEST:ARRAY[4]\" (index 1..1024) are supported."
     },
     "id": {
      "type": "string",
      "description": "Id of the data point to write (mandatory, or path)."
     },
     "create": {
      "type": "boolean",
      "description": "Create the data point when not existing. Default is false.",
      "default": false
     },
     "createDefault": {
      "type": "boolean",
      "description": "Create the data point when not existing. Default is false. The value of an existing data point is not overwritten.",
      "default": false
     },
     "value": {
      "description": "Value to write. To create a node only (without data) send \"value\": null with \"create\": true on a non existing data point. When writing histData, value is optional: if value (incl. type and stamp) is not provided, the most recent valid value from histData (by stamp) is used to create the missing data point, with its stamp; default type then is \"double\" unless type is provided.",
      "nullable": true,
      "oneOf": [
       {
        "type": "number"
       },
       {
        "type": "boolean"
       },
       {
        "type": "string"
       }
      ]
     },
     "state": {
      "type": "string",
      "description": "Only ProMoS NG. State to set: \"ok\", \"noData\" or \"error\". Default is \"ok\". Can be set without any value.",
      "enum": [
       "ok",
       "noData",
       "error"
      ],
      "default": "ok",
      "x-ngOnly": true
     },
     "histData": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/SetHistDataEntry"
      },
      "description": "Historical data to write, compact, detailed or mixed format. For compact entries state \"ok\" is used. If no historical data configuration exists in the DMS, one is created."
     },
     "type": {
      "allOf": [
       {
        "$ref": "#/components/schemas/WriteValueType"
       }
      ],
      "description": "Type of the value; the API checks if it matches the type on the control system. By default the type is evaluated from the JSON data type (string -> string, boolean -> bool, number without decimals -> int, number with decimals -> double). For more accurate type definitions in older ProMoS systems \"int8\", \"uint8\", \"int16\", \"uint16\", \"int32\", \"uint32\" or \"double64\" can be set. \"int\" means \"int32\" for ProMoS NT and \"int64\" for ProMoS NG."
     },
     "stamp": {
      "allOf": [
       {
        "$ref": "#/components/schemas/Timestamp"
       }
      ],
      "description": "Time stamp of the value. Default is the current time stamp."
     },
     "refs": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/NodeRef"
      },
      "description": "Only ProMoS NG. Array of node reference ids with values.",
      "x-ngOnly": true
     },
     "tag": {
      "allOf": [
       {
        "$ref": "#/components/schemas/Tag"
       }
      ],
      "description": "Any data that will be echoed in the response."
     }
    }
   },
   "SetResponseItem": {
    "type": "object",
    "description": "Result for one written data point. Not generated for code \"ok\" when suppressSetOkObject is true.",
    "properties": {
     "code": {
      "type": "string",
      "enum": [
       "ok",
       "no perm",
       "not found",
       "error"
      ],
      "description": "Result code: \"ok\" success, \"no perm\" not allowed to write, \"not found\" data point doesn't exist, \"error\" something went wrong while writing to the control system. Always present."
     },
     "path": {
      "type": "string",
      "description": "Path of the written data point. Present when no fatal error."
     },
     "id": {
      "type": "string",
      "description": "Id of the written data point. Present when no fatal error."
     },
     "value": {
      "description": "The value that was set. Present on code \"ok\".",
      "nullable": true,
      "oneOf": [
       {
        "type": "number"
       },
       {
        "type": "boolean"
       },
       {
        "type": "string"
       }
      ]
     },
     "type": {
      "allOf": [
       {
        "$ref": "#/components/schemas/ValueType"
       }
      ],
      "description": "The type of the value: \"int\", \"double\" (a floating point number), \"string\", \"bool\" or \"none\" for nodes without value. Present on code \"ok\"."
     },
     "stamp": {
      "allOf": [
       {
        "$ref": "#/components/schemas/Timestamp"
       }
      ],
      "description": "ISO 8601 time stamp, can be null. Present on code \"ok\".",
      "nullable": true
     },
     "state": {
      "type": "string",
      "description": "Only ProMoS NG. Sent when the state of the value is not \"ok\"; can be \"error\", \"noData\" or \"pcfError\".",
      "enum": [
       "error",
       "noData",
       "pcfError"
      ],
      "x-ngOnly": true
     },
     "pcfErrors": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/PcfError"
      },
      "description": "Only ProMoS NG. Detailed information about process control function errors. Present on code \"ok\" when errors are pending.",
      "x-ngOnly": true
     },
     "readonly": {
      "type": "boolean",
      "description": "Only ProMoS NG. Sent as true when the data point is read only.",
      "x-ngOnly": true
     },
     "message": {
      "type": "string",
      "description": "Human readable error message in English. Present on codes other than \"ok\"."
     },
     "tag": {
      "allOf": [
       {
        "$ref": "#/components/schemas/Tag"
       }
      ],
      "description": "Tag data from request. Present when existing in the request."
     }
    },
    "required": [
     "code"
    ]
   },
   "RenameRequestItem": {
    "type": "object",
    "description": "One rename definition. To change only the type of a value, use the same path and newPath with the desired type.",
    "properties": {
     "path": {
      "type": "string",
      "description": "Source path of the data point to rename."
     },
     "newPath": {
      "type": "string",
      "description": "Destination path."
     },
     "type": {
      "allOf": [
       {
        "$ref": "#/components/schemas/WriteValueType"
       }
      ],
      "description": "Type of the new data point: \"int\", \"double\", \"string\", \"bool\" or \"none\". For more accurate type definitions in older ProMoS systems \"int8\", \"uint8\", \"int16\", \"uint16\", \"int32\", \"uint32\" or \"double64\" can be set. \"int\" means \"int32\" for ProMoS NT and \"int64\" for ProMoS NG."
     },
     "tag": {
      "allOf": [
       {
        "$ref": "#/components/schemas/Tag"
       }
      ],
      "description": "Any data that will be echoed in the response."
     }
    },
    "required": [
     "path",
     "newPath"
    ]
   },
   "RenameResponseItem": {
    "type": "object",
    "description": "Result of one rename.",
    "properties": {
     "code": {
      "type": "string",
      "enum": [
       "ok",
       "no perm",
       "not found",
       "error"
      ],
      "description": "Result code: \"ok\" success, \"no perm\" not allowed to rename, \"not found\" data point doesn't exist, \"error\" something went wrong while renaming. Always present."
     },
     "path": {
      "type": "string",
      "description": "Path of the original data point. Present when no fatal error."
     },
     "newPath": {
      "type": "string",
      "description": "The renamed path. Present when no fatal error."
     },
     "message": {
      "type": "string",
      "description": "Human readable error message in English. Present on codes other than \"ok\"."
     },
     "tag": {
      "allOf": [
       {
        "$ref": "#/components/schemas/Tag"
       }
      ],
      "description": "Tag data from request. Present when existing in the request."
     }
    },
    "required": [
     "code"
    ]
   },
   "CopyRequestItem": {
    "type": "object",
    "description": "One copy definition.",
    "properties": {
     "path": {
      "type": "string",
      "description": "Source path of the data point to copy."
     },
     "destPath": {
      "type": "string",
      "description": "Destination path."
     },
     "tag": {
      "allOf": [
       {
        "$ref": "#/components/schemas/Tag"
       }
      ],
      "description": "Any data that will be echoed in the response."
     }
    },
    "required": [
     "path",
     "destPath"
    ]
   },
   "CopyResponseItem": {
    "type": "object",
    "description": "Result of one copy.",
    "properties": {
     "code": {
      "type": "string",
      "enum": [
       "ok",
       "no perm",
       "not found",
       "error"
      ],
      "description": "Result code: \"ok\" success, \"not found\" data point doesn't exist, \"error\" something went wrong (e.g. \"Could not copy, destPath exists\"). \"no perm\" no permission. Always present."
     },
     "path": {
      "type": "string",
      "description": "Path of the original data point. Present when no fatal error."
     },
     "destPath": {
      "type": "string",
      "description": "The destination path. Present when no fatal error."
     },
     "message": {
      "type": "string",
      "description": "Human readable error message in English. Present on codes other than \"ok\"."
     },
     "tag": {
      "allOf": [
       {
        "$ref": "#/components/schemas/Tag"
       }
      ],
      "description": "Tag data from request. Present when existing in the request."
     }
    },
    "required": [
     "code"
    ]
   },
   "UpdateBmoRequestItem": {
    "type": "object",
    "description": "One BMO object to balance (update the object instances in the DMS tree from the BMO definition).",
    "properties": {
     "object": {
      "type": "string",
      "description": "The BMO object to update in the DMS tree, e.g. \"MOT01\"."
     },
     "excludeDeletions": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "description": "Only ProMoS NG. Path parts that should not be deleted on the target object. One entry \"*\" means no deletions.",
      "x-ngOnly": true
     },
     "updateValues": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "description": "Only ProMoS NG. BMO path parts whose values should be updated. One entry \"*\" means all values. When not sent, [\"Vers_\", \"PRG\"] is used.",
      "x-ngOnly": true
     },
     "tag": {
      "allOf": [
       {
        "$ref": "#/components/schemas/Tag"
       }
      ],
      "description": "Any data that will be echoed in the response."
     }
    },
    "required": [
     "object"
    ]
   },
   "UpdateBmoResponseItem": {
    "type": "object",
    "description": "Result of one BMO update.",
    "properties": {
     "code": {
      "type": "string",
      "enum": [
       "ok",
       "not found",
       "error"
      ],
      "description": "Result code: \"ok\" success, \"not found\" data point doesn't exist, \"error\" something went wrong. Always present."
     },
     "object": {
      "type": "string",
      "description": "Echo from request. Present when no fatal error."
     },
     "message": {
      "type": "string",
      "description": "Human readable error message in English. Present on codes other than \"ok\"."
     },
     "tag": {
      "allOf": [
       {
        "$ref": "#/components/schemas/Tag"
       }
      ],
      "description": "Tag data from request. Present when existing in the request."
     }
    },
    "required": [
     "code"
    ]
   },
   "DeleteHistDataRange": {
    "type": "object",
    "description": "Time range of historical data to delete.",
    "properties": {
     "start": {
      "allOf": [
       {
        "$ref": "#/components/schemas/Timestamp"
       }
      ],
      "description": "Start time stamp of the range."
     },
     "end": {
      "allOf": [
       {
        "$ref": "#/components/schemas/Timestamp"
       }
      ],
      "description": "End time stamp of the range."
     }
    }
   },
   "DeleteRequestItem": {
    "type": "object",
    "description": "One delete definition. Either \"path\" or \"id\" is mandatory.",
    "properties": {
     "path": {
      "type": "string",
      "description": "Path of the data point to delete (mandatory, or id)."
     },
     "id": {
      "type": "string",
      "description": "Id of the data point to delete (mandatory, or path)."
     },
     "histData": {
      "allOf": [
       {
        "$ref": "#/components/schemas/DeleteHistDataRange"
       }
      ],
      "description": "Object with start and end time stamp: deletes that range of historical data. When histData is set, the data point itself is not deleted."
     },
     "recursive": {
      "type": "boolean",
      "description": "Delete sub paths as well. Default is false. Deleting a data point with existing sub paths and recursive false returns an error with message \"Path is not empty\".",
      "default": false
     },
     "tag": {
      "allOf": [
       {
        "$ref": "#/components/schemas/Tag"
       }
      ],
      "description": "Any data that will be echoed in the response."
     }
    }
   },
   "DeleteResponseItem": {
    "type": "object",
    "description": "Result of one delete.",
    "properties": {
     "code": {
      "type": "string",
      "enum": [
       "ok",
       "no perm",
       "not found",
       "error"
      ],
      "description": "Result code: \"ok\" success, \"no perm\" not allowed to delete, \"not found\" data point doesn't exist, \"error\" something went wrong while deleting. Always present."
     },
     "path": {
      "type": "string",
      "description": "Path of the deleted data point. Present when no fatal error."
     },
     "id": {
      "type": "string",
      "description": "Id of the deleted data point. Present when no fatal error."
     },
     "message": {
      "type": "string",
      "description": "Human readable error message in English. Present on codes other than \"ok\"."
     },
     "tag": {
      "allOf": [
       {
        "$ref": "#/components/schemas/Tag"
       }
      ],
      "description": "Tag data from request. Present when existing in the request."
     }
    },
    "required": [
     "code"
    ]
   },
   "SubscribeEvents": {
    "description": "Requested event(s): one or more of \"onChange\", \"onSet\", \"onCreate\", \"onRename\", \"onDelete\" or \"*\" (all events). Multiple events as comma separated string (e.g. \"onChange,onRename,onDelete\") or as array of strings. Default is \"onChange\".",
    "oneOf": [
     {
      "type": "string"
     },
     {
      "type": "array",
      "items": {
       "type": "string",
       "enum": [
        "onChange",
        "onSet",
        "onCreate",
        "onRename",
        "onDelete",
        "*"
       ]
      }
     }
    ]
   },
   "SubscribeRequestItem": {
    "type": "object",
    "description": "One monitoring definition. Either \"path\" or \"id\" is mandatory. A subscription on the same path with the same tag (on the same connection) overwrites the previous one; different tags allow multiple subscriptions on one path.",
    "properties": {
     "path": {
      "type": "string",
      "description": "Path of the data point to monitor (mandatory, or id)."
     },
     "id": {
      "type": "string",
      "description": "Id of the data point to monitor (mandatory, or path)."
     },
     "query": {
      "allOf": [
       {
        "$ref": "#/components/schemas/GetQuery"
       }
      ],
      "description": "Query object (same as for get). Default is no query. The query content is analyzed at the time of the event."
     },
     "event": {
      "allOf": [
       {
        "$ref": "#/components/schemas/SubscribeEvents"
       }
      ],
      "description": "Requested event(s). Default is \"onChange\"."
     },
     "suppressSubscribeOkObject": {
      "type": "boolean",
      "description": "Only ProMoS NG. When true, no response object is generated on code \"ok\" (reduces traffic).",
      "x-ngOnly": true
     },
     "suppressOwnEvents": {
      "type": "boolean",
      "description": "Only ProMoS NG. If true (default false), no event is sent back to the same WebSocket participant if it was triggered by itself. Any subscribe command overwrites this setting.",
      "default": false,
      "x-ngOnly": true
     },
     "tag": {
      "allOf": [
       {
        "$ref": "#/components/schemas/Tag"
       }
      ],
      "description": "Any data that will be echoed in the response and in the events."
     }
    }
   },
   "UnsubscribeRequestItem": {
    "type": "object",
    "description": "One unsubscribe definition: path and tag used on subscription.",
    "properties": {
     "path": {
      "type": "string",
      "description": "Path of the data point that should no longer be monitored."
     },
     "tag": {
      "allOf": [
       {
        "$ref": "#/components/schemas/Tag"
       }
      ],
      "description": "The tag data used on subscription for this data point."
     }
    },
    "required": [
     "path"
    ]
   },
   "SubscribeResponseItem": {
    "type": "object",
    "description": "Result for one subscribe / unsubscribe entry. Note that previously configured event messages can arrive asynchronously between the subscribe request and its response.",
    "properties": {
     "code": {
      "type": "string",
      "enum": [
       "ok",
       "no perm",
       "not found",
       "error"
      ],
      "description": "Result code: \"ok\" success, \"no perm\" not allowed to monitor, \"not found\" data point doesn't exist, \"error\" something went wrong. Always present."
     },
     "path": {
      "type": "string",
      "description": "Path of the monitored data point. Present when no fatal error."
     },
     "id": {
      "type": "string",
      "description": "Id of the monitored data point. Present when no fatal error."
     },
     "query": {
      "allOf": [
       {
        "$ref": "#/components/schemas/GetQuery"
       }
      ],
      "description": "Echo of the query object from the request. When existing in request."
     },
     "event": {
      "allOf": [
       {
        "$ref": "#/components/schemas/SubscribeEvents"
       }
      ],
      "description": "Echo of the event from the request. When existing in request."
     },
     "value": {
      "description": "The current value. Present on code \"ok\".",
      "nullable": true,
      "oneOf": [
       {
        "type": "number"
       },
       {
        "type": "boolean"
       },
       {
        "type": "string"
       }
      ]
     },
     "type": {
      "allOf": [
       {
        "$ref": "#/components/schemas/ValueType"
       }
      ],
      "description": "The type of the value: \"int\", \"double\" (a floating point number), \"string\", \"bool\" or \"none\" for nodes without value. Present on code \"ok\"."
     },
     "stamp": {
      "allOf": [
       {
        "$ref": "#/components/schemas/Timestamp"
       }
      ],
      "description": "ISO 8601 time stamp, can be null. Present on code \"ok\".",
      "nullable": true
     },
     "extInfos": {
      "allOf": [
       {
        "$ref": "#/components/schemas/ExtInfos"
       }
      ],
      "description": "Extended \"subscriptions\" information for this data point. Present on code \"ok\"."
     },
     "message": {
      "type": "string",
      "description": "Human readable error message in English. Present on codes other than \"ok\"."
     },
     "tag": {
      "allOf": [
       {
        "$ref": "#/components/schemas/Tag"
       }
      ],
      "description": "Tag data from request. Present when existing in the request."
     }
    },
    "required": [
     "code"
    ]
   },
   "EventItem": {
    "type": "object",
    "description": "One entry of the \"event\" array of an asynchronous WebSocket event message. When a data point is renamed, the events onRename, onDelete and onCreate are generated.",
    "properties": {
     "code": {
      "type": "string",
      "enum": [
       "onChange",
       "onSet",
       "onCreate",
       "onRename",
       "onDelete"
      ],
      "description": "The initiating event trigger. Always present."
     },
     "path": {
      "type": "string",
      "description": "Path of the monitored data point. Always present."
     },
     "newPath": {
      "type": "string",
      "description": "The renamed path. Present on code \"onRename\"."
     },
     "trigger": {
      "type": "string",
      "description": "Trigger of the event. For JSON connections the \"whois\" field of the request (set/rename/delete); for ProMoS 1/2 connections (Pipe/TCP) the application name and connection name of the client application (e.g. \"GE@HOST01\"). Other triggers: \"<SYS>\" (internal system operations, e.g. System:Time) or \"<DMS>\" (data points manipulated in the DMS GUI or modified by PLS function). Always present."
     },
     "value": {
      "description": "The value after onChange, onSet, onCreate, onRename; before onDelete. Always present.",
      "nullable": true,
      "oneOf": [
       {
        "type": "number"
       },
       {
        "type": "boolean"
       },
       {
        "type": "string"
       }
      ]
     },
     "type": {
      "allOf": [
       {
        "$ref": "#/components/schemas/ValueType"
       }
      ],
      "description": "Type of the value. Always present."
     },
     "stamp": {
      "allOf": [
       {
        "$ref": "#/components/schemas/Timestamp"
       }
      ],
      "description": "Time stamp of the event, can be null. Always present.",
      "nullable": true
     },
     "message": {
      "type": "string",
      "description": "Human readable error message."
     },
     "tag": {
      "allOf": [
       {
        "$ref": "#/components/schemas/Tag"
       }
      ],
      "description": "Tag data from the subscribe request. When existing in request."
     }
    },
    "required": [
     "code"
    ]
   },
   "VerifyPcfRequestItem": {
    "type": "object",
    "description": "One process control function (PCF) to test.",
    "properties": {
     "path": {
      "type": "string",
      "description": "Path of the process control function's data point to test."
     },
     "pcf": {
      "type": "string",
      "description": "The process control function, e.g. \"JSE ( function() { ... })\"."
     }
    },
    "required": [
     "path",
     "pcf"
    ]
   },
   "VerifyPcfResponseItem": {
    "type": "object",
    "description": "Result of one PCF verification.",
    "properties": {
     "code": {
      "type": "string",
      "enum": [
       "ok",
       "error",
       "not found"
      ],
      "description": "Result code: \"ok\" success, \"error\" any error (also PCF or calculation errors), \"not found\" data point doesn't exist. Always present."
     },
     "path": {
      "type": "string",
      "description": "Path of the requested data point. Present when no fatal error."
     },
     "message": {
      "type": "string",
      "description": "PCF error message during evaluation or calculation error message during execution of the PCF. Empty string means no error. Present when no fatal error (also used for fatal error messages)."
     },
     "result": {
      "description": "Result of the PCF (any type). Only present when the PCF could produce a result."
     }
    },
    "required": [
     "code"
    ]
   },
   "ChangelogGetGroupsRequestItem": {
    "type": "object",
    "description": "The \"changelogGetGroups\" request array is empty; no item fields are defined.",
    "properties": {}
   },
   "ChangelogGetGroupsResponseItem": {
    "type": "object",
    "required": [
     "code"
    ],
    "properties": {
     "code": {
      "type": "string",
      "description": "Result code. \"ok\" on success; any other value indicates an error (see `message`)."
     },
     "groups": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "description": "All change log group names available for the changelogRead command. Present when no fatal error."
     },
     "message": {
      "type": "string",
      "description": "Human readable error message in English. Present when code is other than \"ok\"."
     },
     "tag": {
      "description": "Tag data echoed from the request. Present when it existed in the request."
     }
    }
   },
   "ChangelogCreateRequestItem": {
    "type": "object",
    "required": [
     "group"
    ],
    "description": "Either `path` or `id` is mandatory.",
    "properties": {
     "group": {
      "type": "string",
      "description": "The change log group (e.g. \"Manip1\")."
     },
     "path": {
      "type": "string",
      "description": "The path of the corresponding data point. Mandatory unless `id` is given."
     },
     "id": {
      "type": "string",
      "description": "The id of the corresponding data point. Mandatory unless `path` is given."
     },
     "stamp": {
      "type": "string",
      "description": "Time stamp of the log entry, ISO 8601 formatted."
     },
     "text": {
      "type": "string",
      "description": "The log text."
     },
     "user": {
      "type": "string",
      "description": "Current user."
     },
     "oldValue": {
      "type": "string",
      "description": "Value before change."
     },
     "newValue": {
      "type": "string",
      "description": "Value after change."
     },
     "siteGroup": {
      "type": "number",
      "description": "The site group."
     }
    }
   },
   "ChangelogCreateResponseItem": {
    "type": "object",
    "required": [
     "code"
    ],
    "properties": {
     "code": {
      "type": "string",
      "description": "Result code. \"ok\" on success; any other value indicates an error (see `message`)."
     },
     "id": {
      "type": "string",
      "description": "Unique id for the created change log entry. Present when no fatal error."
     },
     "message": {
      "type": "string",
      "description": "Human readable error message in English. Present when code is other than \"ok\"."
     },
     "tag": {
      "description": "Tag data echoed from the request. Present when it existed in the request."
     }
    }
   },
   "ChangelogFilter": {
    "type": "object",
    "description": "Change log filter object; all members optional. Only ProMoS NG.",
    "x-ngOnly": true,
    "properties": {
     "path": {
      "type": "string",
      "description": "Path to filter - partial match."
     },
     "text": {
      "type": "string",
      "description": "Text to filter - partial match."
     },
     "siteGroup": {
      "type": "array",
      "items": {
       "type": "number"
      },
      "description": "Site groups to include."
     },
     "user": {
      "type": "string",
      "description": "User entry - partial match."
     }
    }
   },
   "ChangelogReadRequestItem": {
    "type": "object",
    "required": [
     "group"
    ],
    "properties": {
     "group": {
      "type": "string",
      "description": "The group name of the change log to read (optional when embedded in a \"get\" command and the path is a change log data point)."
     },
     "start": {
      "type": "string",
      "description": "Requested start time stamp (ISO 8601, see the general time stamp rules of the API). Default is \"first\". Only on ProMoS NG: can also be \"first\", \"last\" or \"now\"."
     },
     "end": {
      "type": "string",
      "description": "Requested end time stamp (ISO 8601, see the general time stamp rules of the API). Default is \"last\". Only on ProMoS NG: can also be \"first\", \"last\" or \"now\"."
     },
     "filter": {
      "allOf": [
       {
        "$ref": "#/components/schemas/ChangelogFilter"
       }
      ],
      "description": "Filter object (only ProMoS NG).",
      "x-ngOnly": true
     },
     "tag": {
      "description": "Any data (object, array, number, string or boolean) that will be echoed in the response."
     },
     "limit": {
      "type": "integer",
      "description": "Limits the result to the defined max entries. When the limit is reached, an additional field \"changelogLimitReached\": true is returned in the response."
     },
     "offset": {
      "type": "integer",
      "description": "The offset from where the records should begin (default 0)."
     },
     "format": {
      "type": "string",
      "description": "Other format than default (only ProMoS NG) - see ProMoS documentation, formats like \"#c / #N / #V^NAME / #z(Ein:Aus) / #u\".",
      "x-ngOnly": true
     },
     "locale": {
      "type": "string",
      "description": "Locale (only ProMoS NG) in the format \"{language lowercase, two-letter, ISO 639}_{country, two-letter, ISO 3166 country code}\", e.g. \"de_CH\".",
      "x-ngOnly": true
     }
    }
   },
   "ChangelogEntry": {
    "type": "object",
    "description": "A change log record.",
    "properties": {
     "id": {
      "type": "string",
      "description": "Unique id for the change log entry (only ProMoS NG).",
      "x-ngOnly": true
     },
     "group": {
      "type": "string",
      "description": "The change log group (e.g. \"Manip1\")."
     },
     "path": {
      "type": "string",
      "description": "The path of the corresponding data point."
     },
     "stamp": {
      "type": "string",
      "description": "Time stamp of the log entry, ISO 8601 formatted."
     },
     "text": {
      "type": "string",
      "description": "The log text."
     },
     "siteGroup": {
      "type": "number",
      "description": "The site group (only ProMoS NG for normal change logs).",
      "x-ngOnly": true
     },
     "oldValue": {
      "type": "string",
      "description": "Value before change (only ProMoS NG with new dbEngine).",
      "x-ngOnly": true
     },
     "newValue": {
      "type": "string",
      "description": "Value after change (only ProMoS NG with new dbEngine).",
      "x-ngOnly": true
     },
     "trigger": {
      "type": "string",
      "description": "Full trigger name (only ProMoS NG with new dbEngine); can also be any internal process or driver. Present when existing.",
      "x-ngOnly": true
     },
     "user": {
      "type": "string",
      "description": "User name responsible for the change (only ProMoS NG with new dbEngine); can also be any internal process or driver. Present when existing.",
      "x-ngOnly": true
     }
    }
   },
   "ChangelogReadResponseItem": {
    "type": "object",
    "required": [
     "code"
    ],
    "properties": {
     "code": {
      "type": "string",
      "description": "Result code. \"ok\" on success; any other value indicates an error (see `message`)."
     },
     "group": {
      "type": "string",
      "description": "Echo from the request. Present when no fatal error."
     },
     "changelog": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/ChangelogEntry"
      },
      "description": "Change log records. Present on code \"ok\"."
     },
     "changelogLimitReached": {
      "type": "boolean",
      "description": "Returned as true when the requested `limit` was reached."
     },
     "message": {
      "type": "string",
      "description": "Human readable error message in English. Present when code is other than \"ok\"."
     },
     "tag": {
      "description": "Tag data echoed from the request. Present when it existed in the request."
     }
    }
   },
   "ChangelogCountRequestItem": {
    "type": "object",
    "required": [
     "group"
    ],
    "properties": {
     "group": {
      "type": "string",
      "description": "The group name of the change log (optional when embedded in a \"get\" command and the path is a change log data point)."
     },
     "start": {
      "type": "string",
      "description": "Requested start time stamp (ISO 8601, see the general time stamp rules of the API). Default is \"first\". Can also be \"first\", \"last\" or \"now\"."
     },
     "end": {
      "type": "string",
      "description": "Requested end time stamp (ISO 8601, see the general time stamp rules of the API). Default is \"last\". Can also be \"first\", \"last\" or \"now\"."
     },
     "filter": {
      "allOf": [
       {
        "$ref": "#/components/schemas/ChangelogFilter"
       }
      ],
      "description": "Filter object, same as for changelogRead."
     },
     "tag": {
      "description": "Any data (object, array, number, string or boolean) that will be echoed in the response."
     }
    }
   },
   "ChangelogCountResponseItem": {
    "type": "object",
    "required": [
     "code"
    ],
    "properties": {
     "code": {
      "type": "string",
      "description": "Result code. \"ok\" on success; any other value indicates an error (see `message`)."
     },
     "group": {
      "type": "string",
      "description": "Echo from the request. Present when no fatal error."
     },
     "countTotal": {
      "type": "integer",
      "description": "Total of resulting entries. Present on code \"ok\"."
     },
     "message": {
      "type": "string",
      "description": "Human readable error message in English. Present when code is other than \"ok\"."
     },
     "tag": {
      "description": "Tag data echoed from the request. Present when it existed in the request."
     }
    }
   },
   "ChangelogSubscribeRequestItem": {
    "type": "object",
    "required": [
     "group"
    ],
    "properties": {
     "group": {
      "type": "string",
      "description": "The group name of the change log to monitor."
     },
     "start": {
      "type": "string",
      "description": "Requested start time stamp (ISO 8601, see the general time stamp rules of the API). Default is \"first\". Only on ProMoS NG: can also be \"first\", \"last\" or \"now\"."
     },
     "end": {
      "type": "string",
      "description": "Requested end time stamp (ISO 8601, see the general time stamp rules of the API). Default is \"last\". Only on ProMoS NG: can also be \"first\", \"last\" or \"now\"."
     },
     "filter": {
      "allOf": [
       {
        "$ref": "#/components/schemas/ChangelogFilter"
       }
      ],
      "description": "Filter object, same as for changelogRead."
     },
     "tag": {
      "description": "Any data that will be echoed in the response and in events. \"group\" and \"tag\" together identify a subscription (unique per WebSocket connection)."
     },
     "format": {
      "type": "string",
      "description": "Other text format than default - see ProMoS documentation, formats like \"#c / #N / #V^NAME / #z(Ein:Aus) / #u\"."
     },
     "locale": {
      "type": "string",
      "description": "Locale in the format \"{language lowercase, two-letter, ISO 639}_{country, two-letter, ISO 3166 country code}\", e.g. \"de_CH\"."
     }
    }
   },
   "ChangelogSubscribeResponseItem": {
    "type": "object",
    "required": [
     "code"
    ],
    "properties": {
     "code": {
      "type": "string",
      "description": "Result code. \"ok\" on success; any other value indicates an error (see `message`)."
     },
     "group": {
      "type": "string",
      "description": "Echo from the request. Present when no fatal error."
     },
     "message": {
      "type": "string",
      "description": "Human readable error message in English. Present when code is other than \"ok\"."
     },
     "tag": {
      "description": "Tag data echoed from the request. Present when it existed in the request."
     }
    }
   },
   "ChangelogEventItem": {
    "type": "object",
    "description": "Entry of the \"eventChangelog\" event array sent over the WebSocket for an active changelogSubscribe.",
    "required": [
     "code",
     "group",
     "trigger",
     "changelog"
    ],
    "properties": {
     "code": {
      "type": "string",
      "description": "The initiating event trigger.",
      "enum": [
       "onCreate",
       "onChange",
       "onDelete"
      ]
     },
     "group": {
      "type": "string",
      "description": "The group of the monitored change log."
     },
     "trigger": {
      "type": "string",
      "description": "The trigger of the event."
     },
     "changelog": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/ChangelogEntry"
      },
      "description": "Change log records."
     },
     "tag": {
      "description": "Tag data from the subscribe request. Present when it existed in the request."
     }
    }
   },
   "ChangelogUnsubscribeRequestItem": {
    "type": "object",
    "required": [
     "group"
    ],
    "properties": {
     "group": {
      "type": "string",
      "description": "The group name of the subscribed change log."
     },
     "tag": {
      "description": "The tag that was used in the subscription. \"group\" and \"tag\" together identify a subscription."
     }
    }
   },
   "ChangelogUnsubscribeResponseItem": {
    "type": "object",
    "required": [
     "code"
    ],
    "properties": {
     "code": {
      "type": "string",
      "description": "Result code. \"ok\" on success; any other value indicates an error (see `message`)."
     },
     "group": {
      "type": "string",
      "description": "Echo from the request. Present when no fatal error."
     },
     "message": {
      "type": "string",
      "description": "Human readable error message in English. Present when code is other than \"ok\"."
     },
     "tag": {
      "description": "Tag data echoed from the request. Present when it existed in the request."
     }
    }
   },
   "AlarmGetGroupsRequestItem": {
    "type": "object",
    "description": "The \"alarmGetGroups\" request array is empty; no item fields are defined.",
    "properties": {}
   },
   "AlarmGetGroupsResponseItem": {
    "type": "object",
    "required": [
     "code"
    ],
    "properties": {
     "code": {
      "type": "string",
      "description": "Result code. \"ok\" on success; any other value indicates an error (see `message`)."
     },
     "groups": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "description": "All alarm group names available for the alarmRead command. Present when no fatal error."
     },
     "message": {
      "type": "string",
      "description": "Human readable error message in English. Present when code is other than \"ok\"."
     },
     "tag": {
      "description": "Tag data echoed from the request. Present when it existed in the request."
     }
    }
   },
   "AlarmCreateRequestItem": {
    "type": "object",
    "required": [
     "group",
     "priority"
    ],
    "description": "Either `path` or `id` is mandatory.",
    "properties": {
     "group": {
      "type": "string",
      "description": "The alarm group (e.g. \"Alarm\")."
     },
     "path": {
      "type": "string",
      "description": "The path of the corresponding data point. Mandatory unless `id` is given."
     },
     "id": {
      "type": "string",
      "description": "The id of the corresponding data point. Mandatory unless `path` is given."
     },
     "stamp": {
      "type": "string",
      "description": "Time stamp of the alarm entry, ISO 8601 formatted."
     },
     "text": {
      "type": "string",
      "description": "The alarm text."
     },
     "user": {
      "type": "string",
      "description": "Current user."
     },
     "oldValue": {
      "type": "string",
      "description": "Value before change."
     },
     "newValue": {
      "type": "string",
      "description": "Value after change."
     },
     "state": {
      "type": "string",
      "description": "The state of the alarm.",
      "enum": [
       "occurred",
       "left",
       "acknowledged",
       "leftAcknowledged"
      ]
     },
     "priority": {
      "type": "integer",
      "description": "The alarm priority."
     },
     "priorityDevice": {
      "type": "integer",
      "description": "The alarm device priority."
     },
     "alarmGroup": {
      "type": "integer",
      "description": "The alarm group (number)."
     },
     "alarmCollectGroup": {
      "type": "integer",
      "description": "The alarm collective group."
     },
     "siteGroup": {
      "type": "integer",
      "description": "The site group."
     }
    }
   },
   "AlarmCreateResponseItem": {
    "type": "object",
    "required": [
     "code"
    ],
    "properties": {
     "code": {
      "type": "string",
      "description": "Result code. \"ok\" on success; any other value indicates an error (see `message`)."
     },
     "id": {
      "type": "string",
      "description": "Unique id for the created alarm entry. Present when no fatal error."
     },
     "message": {
      "type": "string",
      "description": "Human readable error message in English. Present when code is other than \"ok\"."
     },
     "tag": {
      "description": "Tag data echoed from the request. Present when it existed in the request."
     }
    }
   },
   "AlarmFilter": {
    "type": "object",
    "description": "Alarm filter object; all members optional.",
    "properties": {
     "path": {
      "type": "string",
      "description": "Path to filter - partial match."
     },
     "isPending": {
      "type": "boolean",
      "description": "Send pending alarms - default is true."
     },
     "isHistorical": {
      "type": "boolean",
      "description": "Send historical alarms - default is false."
     },
     "state": {
      "type": "array",
      "items": {
       "type": "string",
       "enum": [
        "occurred",
        "left",
        "acknowledged",
        "leftAcknowledged"
       ]
      },
      "description": "Alarm states to include."
     },
     "text": {
      "type": "string",
      "description": "Text to filter - partial match."
     },
     "user": {
      "type": "string",
      "description": "User entry - partial match."
     },
     "alarmCfgNr": {
      "type": "array",
      "items": {
       "type": "integer"
      },
      "description": "Alarm configuration numbers (for alarm configuration \"AlarmX\")."
     },
     "priority": {
      "type": "array",
      "items": {
       "type": "integer"
      },
      "description": "Alarm priorities to include."
     },
     "priorityDevice": {
      "type": "array",
      "items": {
       "type": "integer"
      },
      "description": "Alarm device priorities to include."
     },
     "alarmGroup": {
      "type": "array",
      "items": {
       "type": "integer"
      },
      "description": "Alarm groups (numbers) to include."
     },
     "alarmCollectGroup": {
      "type": "array",
      "items": {
       "type": "integer"
      },
      "description": "Alarm collective groups to include."
     },
     "siteGroup": {
      "type": "array",
      "items": {
       "type": "integer"
      },
      "description": "Site groups to include."
     }
    }
   },
   "AlarmReadRequestItem": {
    "type": "object",
    "properties": {
     "group": {
      "type": "string",
      "description": "The group name of the alarms to read - see alarmGetGroups."
     },
     "start": {
      "type": "string",
      "description": "Requested start time stamp (ISO 8601, see the general time stamp rules of the API). Default is \"first\"."
     },
     "end": {
      "type": "string",
      "description": "Requested end time stamp (ISO 8601, see the general time stamp rules of the API). Default is \"last\"."
     },
     "filter": {
      "allOf": [
       {
        "$ref": "#/components/schemas/AlarmFilter"
       }
      ],
      "description": "Filter object."
     },
     "tag": {
      "description": "Any data (object, array, number, string or boolean) that will be echoed in the response."
     },
     "limit": {
      "type": "integer",
      "description": "Limits the result to the defined max entries. When the limit is reached, an additional field \"alarmLimitReached\": true is returned in the response."
     },
     "offset": {
      "type": "integer",
      "description": "The offset from where the records should begin (default 0)."
     },
     "format": {
      "type": "string",
      "description": "Other text format than default - see ProMoS documentation, formats like \"#c / #N / #V^NAME / #z(Ein:Aus) / #u\"."
     },
     "locale": {
      "type": "string",
      "description": "Locale in the format \"{language lowercase, two-letter, ISO 639}_{country, two-letter, ISO 3166 country code}\", e.g. \"de_CH\"."
     }
    }
   },
   "AlarmEntry": {
    "type": "object",
    "description": "An alarm record.",
    "properties": {
     "id": {
      "type": "string",
      "description": "Unique id for the alarm entry (used e.g. by alarmAcknowledge)."
     },
     "group": {
      "type": "string",
      "description": "The alarm group (e.g. \"Alarm\")."
     },
     "isPending": {
      "type": "boolean",
      "description": "True for a pending alarm (not historical)."
     },
     "path": {
      "type": "string",
      "description": "The path of the corresponding data point."
     },
     "stamp": {
      "type": "string",
      "description": "Time stamp of the entry, ISO 8601 formatted."
     },
     "text": {
      "type": "string",
      "description": "The alarm text."
     },
     "trigger": {
      "type": "string",
      "description": "Trigger for alarm states (only ProMoS NG with new dbEngine). Present when existing.",
      "x-ngOnly": true
     },
     "user": {
      "type": "string",
      "description": "User entry who has acknowledged the alarm (only ProMoS NG with new dbEngine). Present when existing.",
      "x-ngOnly": true
     },
     "oldValue": {
      "type": "string",
      "description": "Value before change (only ProMoS NG with new dbEngine).",
      "x-ngOnly": true
     },
     "newValue": {
      "type": "string",
      "description": "Value after change (only ProMoS NG with new dbEngine).",
      "x-ngOnly": true
     },
     "alarmCfgNr": {
      "type": "integer",
      "description": "The number of the alarm configuration data point (\"Alarmx\")."
     },
     "state": {
      "type": "string",
      "description": "The state of the alarm.",
      "enum": [
       "occurred",
       "left",
       "acknowledged",
       "leftAcknowledged"
      ]
     },
     "priority": {
      "type": "integer",
      "description": "The alarm priority."
     },
     "priorityDevice": {
      "type": "integer",
      "description": "The alarm device priority (only ProMoS NG).",
      "x-ngOnly": true
     },
     "priorityBACnet": {
      "type": "integer",
      "description": "The alarm BACnet priority (only ProMoS NT)."
     },
     "alarmGroup": {
      "type": "integer",
      "description": "The alarm group (number)."
     },
     "alarmCollectGroup": {
      "type": "integer",
      "description": "The alarm collective group."
     },
     "siteGroup": {
      "type": "integer",
      "description": "The site group."
     },
     "screen": {
      "type": "string",
      "description": "The SCADA screen name. Present when existing."
     }
    }
   },
   "AlarmReadResponseItem": {
    "type": "object",
    "required": [
     "code"
    ],
    "properties": {
     "code": {
      "type": "string",
      "description": "Result code. \"ok\" on success; any other value indicates an error (see `message`)."
     },
     "group": {
      "type": "string",
      "description": "Echo from the request. Present when no fatal error."
     },
     "alarms": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/AlarmEntry"
      },
      "description": "Alarm records. Present on code \"ok\"."
     },
     "alarmLimitReached": {
      "type": "boolean",
      "description": "Returned as true when the requested `limit` was reached."
     },
     "message": {
      "type": "string",
      "description": "Human readable error message in English. Present when code is other than \"ok\"."
     },
     "tag": {
      "description": "Tag data echoed from the request. Present when it existed in the request."
     }
    }
   },
   "AlarmAcknowledgeRequestItem": {
    "type": "object",
    "required": [
     "id"
    ],
    "properties": {
     "id": {
      "type": "string",
      "description": "The unique id of the alarm (see `id` in the alarmRead records)."
     },
     "group": {
      "type": "string",
      "description": "The group name of the alarm, e.g. \"Alarm\"."
     },
     "isPending": {
      "type": "boolean",
      "description": "True for a pending alarm, default is true."
     },
     "action": {
      "type": "string",
      "description": "\"set\" (acknowledge), \"reset\" (remove acknowledge) or \"clear\" (mark current alarm as left). Default is \"set\".",
      "enum": [
       "set",
       "reset",
       "clear"
      ]
     },
     "level": {
      "type": "string",
      "description": "\"single\" (only this alarm), \"allForPath\" (all alarms for the same path - only for current alarms) or \"allForObject\" (all alarms for the same object - only for current alarms). Default is \"single\".",
      "enum": [
       "single",
       "allForPath",
       "allForObject"
      ]
     },
     "tag": {
      "description": "Any data (object, array, number, string or boolean) that will be echoed in the response."
     }
    }
   },
   "AlarmAcknowledgeResponseItem": {
    "type": "object",
    "required": [
     "code"
    ],
    "properties": {
     "code": {
      "type": "string",
      "description": "Result code. \"ok\" on success; any other value indicates an error (see `message`)."
     },
     "group": {
      "type": "string",
      "description": "Echo from the request. Present when no fatal error."
     },
     "id": {
      "type": "string",
      "description": "Echo from the request. Present on code \"ok\"."
     },
     "action": {
      "type": "string",
      "description": "Echo from the request. Present on code \"ok\"."
     },
     "message": {
      "type": "string",
      "description": "Human readable error message in English. Present when code is other than \"ok\"."
     },
     "tag": {
      "description": "Tag data echoed from the request. Present when it existed in the request."
     }
    }
   },
   "AlarmCountRequestItem": {
    "type": "object",
    "properties": {
     "group": {
      "type": "string",
      "description": "The group name of the alarms to count. Empty for all groups."
     },
     "start": {
      "type": "string",
      "description": "Requested start time stamp (ISO 8601, see the general time stamp rules of the API). Default is \"first\". Can also be \"first\", \"last\" or \"now\"."
     },
     "end": {
      "type": "string",
      "description": "Requested end time stamp (ISO 8601, see the general time stamp rules of the API). Default is \"last\". Can also be \"first\", \"last\" or \"now\"."
     },
     "filter": {
      "allOf": [
       {
        "$ref": "#/components/schemas/AlarmFilter"
       }
      ],
      "description": "Filter object, same as for alarmRead."
     },
     "tag": {
      "description": "Any data (object, array, number, string or boolean) that will be echoed in the response."
     }
    }
   },
   "AlarmCounters": {
    "type": "object",
    "description": "Alarm counters per state.",
    "properties": {
     "occurred": {
      "type": "integer",
      "description": "Count of all alarms in state \"occurred\" (new alarm, not acknowledged)."
     },
     "left": {
      "type": "integer",
      "description": "Count of all alarms in state \"left\" (alarm has left, not acknowledged)."
     },
     "acknowledged": {
      "type": "integer",
      "description": "Count of all alarms in state \"acknowledged\" (new alarm, acknowledged)."
     },
     "leftAcknowledged": {
      "type": "integer",
      "description": "Count of all alarms in state \"leftAcknowledged\" (alarm has left, acknowledged - only in historical alarms)."
     }
    }
   },
   "AlarmCountResponseItem": {
    "type": "object",
    "required": [
     "code"
    ],
    "properties": {
     "code": {
      "type": "string",
      "description": "Result code. \"ok\" on success; any other value indicates an error (see `message`)."
     },
     "group": {
      "type": "string",
      "description": "Echo from the request. Present when no fatal error."
     },
     "countTotal": {
      "type": "integer",
      "description": "Total alarms. Present on code \"ok\"."
     },
     "countAlarm": {
      "allOf": [
       {
        "$ref": "#/components/schemas/AlarmCounters"
       }
      ],
      "description": "Counters per alarm state. Present on code \"ok\", only for alarms."
     },
     "message": {
      "type": "string",
      "description": "Human readable error message in English. Present when code is other than \"ok\"."
     },
     "tag": {
      "description": "Tag data echoed from the request. Present when it existed in the request."
     }
    }
   },
   "AlarmSubscribeRequestItem": {
    "type": "object",
    "properties": {
     "group": {
      "type": "string",
      "description": "The group name of the alarms to monitor."
     },
     "start": {
      "type": "string",
      "description": "Requested start time stamp (ISO 8601, see the general time stamp rules of the API). Default is \"first\". Can also be \"first\", \"last\" or \"now\"."
     },
     "end": {
      "type": "string",
      "description": "Requested end time stamp (ISO 8601, see the general time stamp rules of the API). Default is \"last\". Can also be \"first\", \"last\" or \"now\"."
     },
     "filter": {
      "allOf": [
       {
        "$ref": "#/components/schemas/AlarmFilter"
       }
      ],
      "description": "Filter object, same as for alarmRead."
     },
     "tag": {
      "description": "Any data that will be echoed in the response and in events. \"group\" and \"tag\" together identify a subscription (unique per WebSocket connection)."
     },
     "format": {
      "type": "string",
      "description": "Other text format than default - see ProMoS documentation, formats like \"#c / #N / #V^NAME / #z(Ein:Aus) / #u\"."
     },
     "locale": {
      "type": "string",
      "description": "Locale in the format \"{language lowercase, two-letter, ISO 639}_{country, two-letter, ISO 3166 country code}\", e.g. \"de_CH\"."
     }
    }
   },
   "AlarmSubscribeResponseItem": {
    "type": "object",
    "required": [
     "code"
    ],
    "properties": {
     "code": {
      "type": "string",
      "description": "Result code. \"ok\" on success; any other value indicates an error (see `message`)."
     },
     "group": {
      "type": "string",
      "description": "Echo from the request. Present when no fatal error."
     },
     "message": {
      "type": "string",
      "description": "Human readable error message in English. Present when code is other than \"ok\"."
     },
     "tag": {
      "description": "Tag data echoed from the request. Present when it existed in the request."
     }
    }
   },
   "AlarmEventItem": {
    "type": "object",
    "description": "Entry of the \"eventAlarms\" event array sent over the WebSocket for an active alarmSubscribe.",
    "required": [
     "code",
     "group",
     "trigger",
     "alarms"
    ],
    "properties": {
     "code": {
      "type": "string",
      "description": "The initiating event trigger.",
      "enum": [
       "onCreate",
       "onChange",
       "onDelete"
      ]
     },
     "group": {
      "type": "string",
      "description": "The group of the monitored alarms."
     },
     "trigger": {
      "type": "string",
      "description": "The trigger of the event."
     },
     "alarms": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/AlarmEntry"
      },
      "description": "Alarm records."
     },
     "tag": {
      "description": "Tag data from the subscribe request. Present when it existed in the request."
     }
    }
   },
   "AlarmUnsubscribeRequestItem": {
    "type": "object",
    "properties": {
     "group": {
      "type": "string",
      "description": "The group name of the subscribed alarms."
     },
     "tag": {
      "description": "The tag that was used in the subscription. \"group\" and \"tag\" together identify a subscription."
     }
    }
   },
   "AlarmUnsubscribeResponseItem": {
    "type": "object",
    "required": [
     "code"
    ],
    "properties": {
     "code": {
      "type": "string",
      "description": "Result code. \"ok\" on success; any other value indicates an error (see `message`)."
     },
     "group": {
      "type": "string",
      "description": "Echo from the request. Present when no fatal error."
     },
     "message": {
      "type": "string",
      "description": "Human readable error message in English. Present when code is other than \"ok\"."
     },
     "tag": {
      "description": "Tag data echoed from the request. Present when it existed in the request."
     }
    }
   },
   "AlarmSubscribeCountRequestItem": {
    "type": "object",
    "properties": {
     "group": {
      "type": "string",
      "description": "The group name of the alarm counters to monitor."
     },
     "start": {
      "type": "string",
      "description": "Requested start time stamp (ISO 8601, see the general time stamp rules of the API). Default is \"first\". Can also be \"first\", \"last\" or \"now\"."
     },
     "end": {
      "type": "string",
      "description": "Requested end time stamp (ISO 8601, see the general time stamp rules of the API). Default is \"last\". Can also be \"first\", \"last\" or \"now\"."
     },
     "filter": {
      "allOf": [
       {
        "$ref": "#/components/schemas/AlarmFilter"
       }
      ],
      "description": "Filter object, same as for alarmRead."
     },
     "tag": {
      "description": "Any data that will be echoed in the response and in events. \"group\" and \"tag\" together identify a subscription (unique per WebSocket connection)."
     }
    }
   },
   "AlarmSubscribeCountResponseItem": {
    "type": "object",
    "required": [
     "code"
    ],
    "properties": {
     "code": {
      "type": "string",
      "description": "Result code. \"ok\" on success; any other value indicates an error (see `message`)."
     },
     "group": {
      "type": "string",
      "description": "Echo from the request. Present when no fatal error."
     },
     "message": {
      "type": "string",
      "description": "Human readable error message in English. Present when code is other than \"ok\"."
     },
     "tag": {
      "description": "Tag data echoed from the request. Present when it existed in the request."
     }
    }
   },
   "AlarmCountEventItem": {
    "type": "object",
    "description": "Entry of the \"eventAlarmCount\" event array sent over the WebSocket for an active alarmSubscribeCount.",
    "required": [
     "code",
     "group",
     "trigger",
     "countTotal",
     "countAlarm"
    ],
    "properties": {
     "code": {
      "type": "string",
      "description": "The initiating event trigger.",
      "enum": [
       "onChange"
      ]
     },
     "group": {
      "type": "string",
      "description": "The group of the monitored counters."
     },
     "trigger": {
      "type": "string",
      "description": "The trigger of the event."
     },
     "countTotal": {
      "type": "integer",
      "description": "Total alarms."
     },
     "countAlarm": {
      "$ref": "#/components/schemas/AlarmCounters"
     },
     "tag": {
      "description": "Tag data from the subscribe request. Present when it existed in the request."
     }
    }
   },
   "AlarmUnsubscribeCountRequestItem": {
    "type": "object",
    "properties": {
     "group": {
      "type": "string",
      "description": "The group name of the subscribed counters."
     },
     "tag": {
      "description": "The tag that was used in the subscription. \"group\" and \"tag\" together identify a subscription."
     }
    }
   },
   "AlarmUnsubscribeCountResponseItem": {
    "type": "object",
    "required": [
     "code"
    ],
    "properties": {
     "code": {
      "type": "string",
      "description": "Result code. \"ok\" on success; any other value indicates an error (see `message`)."
     },
     "group": {
      "type": "string",
      "description": "Echo from the request. Present when no fatal error."
     },
     "message": {
      "type": "string",
      "description": "Human readable error message in English. Present when code is other than \"ok\"."
     },
     "tag": {
      "description": "Tag data echoed from the request. Present when it existed in the request."
     }
    }
   },
   "VersionRequestItem": {
    "type": "object",
    "description": "The \"version\" request array is empty; no item fields are defined.",
    "properties": {}
   },
   "VersionInfo": {
    "type": "object",
    "description": "Detailed version info object (used for appVersion and setupVersion).",
    "required": [
     "full",
     "major",
     "minor",
     "setup",
     "build"
    ],
    "properties": {
     "full": {
      "type": "string",
      "description": "Full version string, e.g. \"2.23.110.206\"."
     },
     "major": {
      "type": "integer",
      "description": "Major number."
     },
     "minor": {
      "type": "integer",
      "description": "Minor number."
     },
     "setup": {
      "type": "integer",
      "description": "Setup number."
     },
     "build": {
      "type": "integer",
      "description": "Build number."
     },
     "siteGroup": {
      "type": "integer",
      "description": "The site group."
     }
    }
   },
   "VersionLimitations": {
    "type": "object",
    "description": "Server limitations (shown in the examples).",
    "properties": {
     "maxPathLength": {
      "type": "integer",
      "description": "Maximum data point path length."
     },
     "queryMaxDepth": {
      "type": "integer",
      "description": "Maximum query depth."
     },
     "queryMaxResults": {
      "type": "integer",
      "description": "Maximum number of query results."
     },
     "histdataMaxResults": {
      "type": "integer",
      "description": "Maximum number of historical data results."
     },
     "changelogMaxResults": {
      "type": "integer",
      "description": "Maximum number of change log results."
     },
     "websocketMaxReceiveFrameSize": {
      "type": "integer",
      "description": "Maximum WebSocket receive frame size (bytes)."
     },
     "websocketMaxReceiveMessageSize": {
      "type": "integer",
      "description": "Maximum WebSocket receive message size (bytes)."
     }
    }
   },
   "VersionCapabilities": {
    "type": "object",
    "description": "Server capabilities. See the examples of the version command for the structure.",
    "properties": {
     "commands": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "description": "Supported commands/features, e.g. \"get\", \"get-histData\", \"get-histData-interpolate\", \"changelogRead\", \"alarmSubscribe\", \"HTTP_import-v2\", \"HTTP_export-v2\"."
     },
     "limitations": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/VersionLimitations"
      },
      "description": "Server limitations (an array with one object in the examples)."
     }
    }
   },
   "VersionResponseItem": {
    "type": "object",
    "required": [
     "code"
    ],
    "properties": {
     "code": {
      "type": "string",
      "description": "\"ok\" on ProMoS NG; \"error\" on ProMoS NT (command unknown)."
     },
     "message": {
      "type": "string",
      "description": "Human readable error message in English. Present when code is other than \"ok\"."
     },
     "app": {
      "type": "string",
      "description": "Application name, e.g. \"DMS\"."
     },
     "description": {
      "type": "string",
      "description": "Application description."
     },
     "date": {
      "type": "string",
      "description": "Application build date, e.g. \"2023-10-02 13:56\"."
     },
     "copyright": {
      "type": "string",
      "description": "Copyright string."
     },
     "appVersion": {
      "allOf": [
       {
        "$ref": "#/components/schemas/VersionInfo"
       }
      ],
      "description": "Application version."
     },
     "setupVersion": {
      "allOf": [
       {
        "$ref": "#/components/schemas/VersionInfo"
       }
      ],
      "description": "Setup version."
     },
     "capabilities": {
      "$ref": "#/components/schemas/VersionCapabilities"
     },
     "tag": {
      "description": "Tag data echoed from the request. Present when it existed in the request."
     }
    }
   },
   "InterpolateGetTemplatesRequestItem": {
    "type": "object",
    "description": "The \"interpolateGetTemplates\" request array is empty; no item fields are defined.",
    "properties": {}
   },
   "InterpolateTemplate": {
    "type": "object",
    "required": [
     "name",
     "description",
     "dataClasses",
     "usages"
    ],
    "properties": {
     "name": {
      "type": "string",
      "description": "Name of the template; can be used for parameter \"interpolateTemplate\" when requesting historical data."
     },
     "description": {
      "type": "string",
      "description": "Description of the template."
     },
     "dataClasses": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "description": "Data classes (e.g. \"any\", \"counterUp\"); can be used to filter templates for selection."
     },
     "usages": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "description": "Usages (e.g. \"any\", \"BAI\"); can be used to filter templates for selection."
     },
     "interpolateParam": {
      "type": "object",
      "additionalProperties": true,
      "description": "Interpolation parameters as in the historical data request (get-histData `interpolateParam`, e.g. `method`, `interval`). Present when configured."
     },
     "filterParams": {
      "type": "array",
      "items": {
       "type": "object",
       "additionalProperties": true
      },
      "description": "Filter parameters as in the historical data request. Present when configured."
     },
     "normalizeParams": {
      "type": "array",
      "items": {
       "type": "object",
       "additionalProperties": true
      },
      "description": "Normalize parameters as in the historical data request. Present when configured."
     }
    }
   },
   "InterpolateGetTemplatesResponseItem": {
    "type": "object",
    "required": [
     "code"
    ],
    "properties": {
     "code": {
      "type": "string",
      "description": "Result code. \"ok\" on success; any other value indicates an error (see `message`)."
     },
     "message": {
      "type": "string",
      "description": "Human readable error message in English. Present when code is other than \"ok\"."
     },
     "templates": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/InterpolateTemplate"
      },
      "description": "Array of templates. Present when no fatal error."
     },
     "tag": {
      "description": "Tag data echoed from the request. Present when it existed in the request."
     }
    }
   },
   "NodeRefRequestItem": {
    "type": "integer",
    "description": "Optional reference id to filter by. The \"nodeReferences\" request array is either empty (all references) or an array of numbers with the ids to return."
   },
   "NodeRefReference": {
    "type": "object",
    "required": [
     "id",
     "name",
     "description"
    ],
    "properties": {
     "id": {
      "type": "integer",
      "description": "Id of the reference."
     },
     "name": {
      "type": "string",
      "description": "Name of the reference."
     },
     "description": {
      "type": "string",
      "description": "Description of the reference."
     },
     "formSchema": {
      "type": "array",
      "items": {},
      "description": "vendor-specific data. Optional."
     }
    }
   },
   "NodeRefResponseItem": {
    "type": "object",
    "required": [
     "code"
    ],
    "properties": {
     "code": {
      "type": "string",
      "description": "Result code. \"ok\" on success; any other value indicates an error (see `message`)."
     },
     "message": {
      "type": "string",
      "description": "Human readable error message in English. Present when code is other than \"ok\"."
     },
     "references": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/NodeRefReference"
      },
      "description": "Array of references. Present when no fatal error."
     },
     "tag": {
      "description": "Tag data echoed from the request. Present when it existed in the request."
     }
    }
   },
   "AuthValidateUserRequestItem": {
    "type": "object",
    "required": [
     "loginName",
     "password"
    ],
    "additionalProperties": false,
    "properties": {
     "loginName": {
      "type": "string",
      "description": "The log in name of the user."
     },
     "password": {
      "type": "string",
      "description": "The password of the user. Can be plain text or MD5 hashed.",
      "format": "password"
     },
     "host": {
      "type": "string",
      "description": "Any host information like computer name. Optional, can be empty."
     },
     "tag": {
      "description": "Any data (object, array, number, string or boolean) that will be echoed in the response."
     }
    }
   },
   "AuthUserData": {
    "type": "object",
    "description": "Information about the validated user.",
    "properties": {
     "userName": {
      "type": "string",
      "description": "The user name."
     },
     "comment": {
      "type": "string",
      "description": "The comment for this user."
     },
     "language": {
      "type": "string",
      "description": "The user language; can be empty or any ISO 639-2 code like \"ger\" / \"eng\"."
     },
     "host": {
      "type": "string",
      "description": "Host information."
     },
     "startImage": {
      "type": "string",
      "description": "The starting image name for this user after login."
     },
     "isAdmin": {
      "type": "boolean",
      "description": "User admin flag."
     },
     "isUserAdmin": {
      "type": "boolean",
      "description": "User admin flag to manipulate users."
     },
     "hasAutoLogin": {
      "type": "boolean",
      "description": "User is logged in automatically."
     },
     "hasAutoLogoff": {
      "type": "boolean",
      "description": "User is logged off automatically after timeout."
     },
     "allowedWebAccess": {
      "type": "boolean",
      "description": "User can log in over web access."
     },
     "accessLevels": {
      "type": "array",
      "items": {
       "type": "integer",
       "minimum": 1,
       "maximum": 16
      },
      "description": "Enabled user access levels (levels 1-16 for ProMoS NT1 / NT2 / NG)."
     },
     "stationLevels": {
      "type": "array",
      "items": {
       "type": "integer",
       "minimum": 1,
       "maximum": 8
      },
      "description": "Enabled user station access levels (levels 1-8 for ProMoS NT1 / NT2 / NG)."
     }
    }
   },
   "AuthValidateUserResponseItem": {
    "type": "object",
    "required": [
     "code"
    ],
    "properties": {
     "code": {
      "type": "string",
      "description": "\"ok\" on success, \"invalid credentials\" if loginName / password are not valid, \"error\" in case of a fatal error.",
      "enum": [
       "ok",
       "invalid credentials",
       "error"
      ]
     },
     "message": {
      "type": "string",
      "description": "Human readable error message in English. Present when code is other than \"ok\"."
     },
     "loginName": {
      "type": "string",
      "description": "Echo from the request. Present when no fatal error."
     },
     "userData": {
      "allOf": [
       {
        "$ref": "#/components/schemas/AuthUserData"
       }
      ],
      "description": "Information about the user. Present on code \"ok\"."
     },
     "tag": {
      "description": "Tag data echoed from the request. Present when it existed in the request."
     }
    }
   },
   "ImportDataPointsResult": {
    "type": "object",
    "description": "JSON result of a data point import (/import/v1, /import/v2).",
    "properties": {
     "beforeImport": {
      "$ref": "#/components/schemas/ImportNodeCounters"
     },
     "afterImport": {
      "$ref": "#/components/schemas/ImportNodeCounters"
     },
     "errors": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "description": "Error messages for lines that could not be imported (lines without error are imported)."
     }
    }
   },
   "ImportNodeCounters": {
    "type": "object",
    "description": "Node counters before/after an import.",
    "properties": {
     "nodes": {
      "type": "integer",
      "description": "Number of data point nodes."
     },
     "pcf": {
      "type": "integer",
      "description": "Number of process control functions (PCF)."
     }
    }
   },
   "ImportHistDataResult": {
    "type": "object",
    "description": "JSON result of a historical data import (/historical_data_import/v1).",
    "properties": {
     "imported": {
      "type": "integer",
      "description": "Number of imported values."
     },
     "errors": {
      "type": "array",
      "items": {
       "type": "string"
      },
      "description": "Error messages for lines that could not be imported. The import is aborted after a maximum of 100 errors."
     }
    }
   },
   "ExportDataPointV2Line": {
    "type": "object",
    "description": "One line of the v2 (JSON Lines, UTF-8) data point import/export format.",
    "properties": {
     "path": {
      "type": "string",
      "description": "Data point path."
     },
     "type": {
      "type": "string",
      "description": "Data point type, e.g. \"int\", \"bool\"."
     },
     "value": {
      "description": "Data point value (type depends on `type`)."
     },
     "stamp": {
      "type": "string",
      "description": "Time stamp, ISO 8601 formatted."
     },
     "state": {
      "type": "string",
      "description": "Value state, e.g. \"ok\"."
     }
    }
   },
   "GetRequest": {
    "type": "object",
    "title": "get request",
    "description": "Read data point values, query the DMS tree and read historical data.",
    "required": [
     "get"
    ],
    "properties": {
     "get": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/GetRequestItem"
      }
     },
     "tag": {
      "description": "Any JSON value (except null), echoed in the response."
     }
    }
   },
   "GetResponse": {
    "type": "object",
    "title": "get response",
    "properties": {
     "get": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/GetResponseItem"
      }
     },
     "tag": {
      "description": "Echo of the request tag."
     }
    }
   },
   "SetRequest": {
    "type": "object",
    "title": "set request",
    "description": "Write data point values, states, references or historical data (optionally creating data points).",
    "required": [
     "set"
    ],
    "properties": {
     "set": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/SetRequestItem"
      }
     },
     "whois": {
      "type": "string",
      "description": "Identification of the client (required for write access if the connection is not authenticated)."
     },
     "user": {
      "type": "string",
      "description": "User name."
     },
     "suppressSetOkObject": {
      "description": "Top-level field `suppressSetOkObject`, see command description."
     },
     "tag": {
      "description": "Any JSON value (except null), echoed in the response."
     }
    }
   },
   "SetResponse": {
    "type": "object",
    "title": "set response",
    "properties": {
     "set": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/SetResponseItem"
      }
     },
     "tag": {
      "description": "Echo of the request tag."
     }
    }
   },
   "RenameRequest": {
    "type": "object",
    "title": "rename request",
    "description": "Rename (move) data points or change the type of a data point.",
    "required": [
     "rename"
    ],
    "properties": {
     "rename": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/RenameRequestItem"
      }
     },
     "whois": {
      "type": "string",
      "description": "Identification of the client (required for write access if the connection is not authenticated)."
     },
     "tag": {
      "description": "Any JSON value (except null), echoed in the response."
     }
    }
   },
   "RenameResponse": {
    "type": "object",
    "title": "rename response",
    "properties": {
     "rename": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/RenameResponseItem"
      }
     },
     "tag": {
      "description": "Echo of the request tag."
     }
    }
   },
   "CopyRequest": {
    "type": "object",
    "title": "copy request",
    "description": "Copy data points to a destination path.",
    "required": [
     "copy"
    ],
    "properties": {
     "copy": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/CopyRequestItem"
      }
     },
     "whois": {
      "type": "string",
      "description": "Identification of the client (required for write access if the connection is not authenticated)."
     },
     "tag": {
      "description": "Any JSON value (except null), echoed in the response."
     }
    }
   },
   "CopyResponse": {
    "type": "object",
    "title": "copy response",
    "properties": {
     "copy": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/CopyResponseItem"
      }
     },
     "tag": {
      "description": "Echo of the request tag."
     }
    }
   },
   "UpdateBMORequest": {
    "type": "object",
    "title": "updateBMO request",
    "description": "Balance (update) the DMS instances of a BMO object definition.",
    "required": [
     "updateBMO"
    ],
    "properties": {
     "updateBMO": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/UpdateBmoRequestItem"
      }
     },
     "whois": {
      "type": "string",
      "description": "Identification of the client (required for write access if the connection is not authenticated)."
     },
     "tag": {
      "description": "Any JSON value (except null), echoed in the response."
     }
    }
   },
   "UpdateBMOResponse": {
    "type": "object",
    "title": "updateBMO response",
    "properties": {
     "updateBMO": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/UpdateBmoResponseItem"
      }
     },
     "tag": {
      "description": "Echo of the request tag."
     }
    }
   },
   "DeleteRequest": {
    "type": "object",
    "title": "delete request",
    "description": "Delete data points or a range of their historical data.",
    "required": [
     "delete"
    ],
    "properties": {
     "delete": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/DeleteRequestItem"
      }
     },
     "whois": {
      "type": "string",
      "description": "Identification of the client (required for write access if the connection is not authenticated)."
     },
     "user": {
      "type": "string",
      "description": "User name."
     },
     "tag": {
      "description": "Any JSON value (except null), echoed in the response."
     }
    }
   },
   "DeleteResponse": {
    "type": "object",
    "title": "delete response",
    "properties": {
     "delete": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/DeleteResponseItem"
      }
     },
     "tag": {
      "description": "Echo of the request tag."
     }
    }
   },
   "SubscribeRequest": {
    "type": "object",
    "title": "subscribe request",
    "description": "Monitor data points for changes (WebSocket only).",
    "required": [
     "subscribe"
    ],
    "properties": {
     "subscribe": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/SubscribeRequestItem"
      }
     },
     "tag": {
      "description": "Any JSON value (except null), echoed in the response."
     }
    }
   },
   "SubscribeResponse": {
    "type": "object",
    "title": "subscribe response",
    "properties": {
     "subscribe": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/SubscribeResponseItem"
      }
     },
     "tag": {
      "description": "Echo of the request tag."
     }
    }
   },
   "UnsubscribeRequest": {
    "type": "object",
    "title": "unsubscribe request",
    "description": "Stop monitoring data points (WebSocket only).",
    "required": [
     "unsubscribe"
    ],
    "properties": {
     "unsubscribe": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/UnsubscribeRequestItem"
      }
     },
     "tag": {
      "description": "Any JSON value (except null), echoed in the response."
     }
    }
   },
   "UnsubscribeResponse": {
    "type": "object",
    "title": "unsubscribe response",
    "properties": {
     "unsubscribe": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/SubscribeResponseItem"
      }
     },
     "tag": {
      "description": "Echo of the request tag."
     }
    }
   },
   "VerifyPcfRequest": {
    "type": "object",
    "title": "verifyPcf request",
    "description": "Test a process control function (PCF) for a data point and return its result.",
    "required": [
     "verifyPcf"
    ],
    "properties": {
     "verifyPcf": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/VerifyPcfRequestItem"
      }
     },
     "tag": {
      "description": "Any JSON value (except null), echoed in the response."
     }
    }
   },
   "VerifyPcfResponse": {
    "type": "object",
    "title": "verifyPcf response",
    "properties": {
     "verifyPcf": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/VerifyPcfResponseItem"
      }
     },
     "tag": {
      "description": "Echo of the request tag."
     }
    }
   },
   "ChangelogGetGroupsRequest": {
    "type": "object",
    "title": "changelogGetGroups request",
    "description": "Get all available change log groups.",
    "required": [
     "changelogGetGroups"
    ],
    "properties": {
     "changelogGetGroups": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/ChangelogGetGroupsRequestItem"
      }
     },
     "whois": {
      "type": "string",
      "description": "Identification of the client (required for write access if the connection is not authenticated)."
     },
     "tag": {
      "description": "Any JSON value (except null), echoed in the response."
     }
    }
   },
   "ChangelogGetGroupsResponse": {
    "type": "object",
    "title": "changelogGetGroups response",
    "properties": {
     "changelogGetGroups": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/ChangelogGetGroupsResponseItem"
      }
     },
     "tag": {
      "description": "Echo of the request tag."
     }
    }
   },
   "ChangelogCreateRequest": {
    "type": "object",
    "title": "changelogCreate request",
    "description": "Create a new change log entry.",
    "required": [
     "changelogCreate"
    ],
    "properties": {
     "changelogCreate": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/ChangelogCreateRequestItem"
      }
     },
     "whois": {
      "type": "string",
      "description": "Identification of the client (required for write access if the connection is not authenticated)."
     },
     "tag": {
      "description": "Any JSON value (except null), echoed in the response."
     }
    }
   },
   "ChangelogCreateResponse": {
    "type": "object",
    "title": "changelogCreate response",
    "properties": {
     "changelogCreate": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/ChangelogCreateResponseItem"
      }
     },
     "tag": {
      "description": "Echo of the request tag."
     }
    }
   },
   "ChangelogReadRequest": {
    "type": "object",
    "title": "changelogRead request",
    "description": "Read the content of a specific change log group.",
    "required": [
     "changelogRead"
    ],
    "properties": {
     "changelogRead": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/ChangelogReadRequestItem"
      }
     },
     "whois": {
      "type": "string",
      "description": "Identification of the client (required for write access if the connection is not authenticated)."
     },
     "tag": {
      "description": "Any JSON value (except null), echoed in the response."
     }
    }
   },
   "ChangelogReadResponse": {
    "type": "object",
    "title": "changelogRead response",
    "properties": {
     "changelogRead": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/ChangelogReadResponseItem"
      }
     },
     "tag": {
      "description": "Echo of the request tag."
     }
    }
   },
   "ChangelogCountRequest": {
    "type": "object",
    "title": "changelogCount request",
    "description": "Get counters of a specific change log group.",
    "required": [
     "changelogCount"
    ],
    "properties": {
     "changelogCount": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/ChangelogCountRequestItem"
      }
     },
     "whois": {
      "type": "string",
      "description": "Identification of the client (required for write access if the connection is not authenticated)."
     },
     "tag": {
      "description": "Any JSON value (except null), echoed in the response."
     }
    }
   },
   "ChangelogCountResponse": {
    "type": "object",
    "title": "changelogCount response",
    "properties": {
     "changelogCount": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/ChangelogCountResponseItem"
      }
     },
     "tag": {
      "description": "Echo of the request tag."
     }
    }
   },
   "ChangelogSubscribeRequest": {
    "type": "object",
    "title": "changelogSubscribe request",
    "description": "Monitor a change log group (WebSocket only).",
    "required": [
     "changelogSubscribe"
    ],
    "properties": {
     "changelogSubscribe": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/ChangelogSubscribeRequestItem"
      }
     },
     "whois": {
      "type": "string",
      "description": "Identification of the client (required for write access if the connection is not authenticated)."
     },
     "tag": {
      "description": "Any JSON value (except null), echoed in the response."
     }
    }
   },
   "ChangelogSubscribeResponse": {
    "type": "object",
    "title": "changelogSubscribe response",
    "properties": {
     "changelogSubscribe": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/ChangelogSubscribeResponseItem"
      }
     },
     "tag": {
      "description": "Echo of the request tag."
     }
    }
   },
   "ChangelogUnsubscribeRequest": {
    "type": "object",
    "title": "changelogUnsubscribe request",
    "description": "Unsubscribe a monitored change log group (WebSocket only).",
    "required": [
     "changelogUnsubscribe"
    ],
    "properties": {
     "changelogUnsubscribe": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/ChangelogUnsubscribeRequestItem"
      }
     },
     "whois": {
      "type": "string",
      "description": "Identification of the client (required for write access if the connection is not authenticated)."
     },
     "tag": {
      "description": "Any JSON value (except null), echoed in the response."
     }
    }
   },
   "ChangelogUnsubscribeResponse": {
    "type": "object",
    "title": "changelogUnsubscribe response",
    "properties": {
     "changelogUnsubscribe": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/ChangelogUnsubscribeResponseItem"
      }
     },
     "tag": {
      "description": "Echo of the request tag."
     }
    }
   },
   "AlarmGetGroupsRequest": {
    "type": "object",
    "title": "alarmGetGroups request",
    "description": "Get all available alarm groups.",
    "required": [
     "alarmGetGroups"
    ],
    "properties": {
     "alarmGetGroups": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/AlarmGetGroupsRequestItem"
      }
     },
     "whois": {
      "type": "string",
      "description": "Identification of the client (required for write access if the connection is not authenticated)."
     },
     "tag": {
      "description": "Any JSON value (except null), echoed in the response."
     }
    }
   },
   "AlarmGetGroupsResponse": {
    "type": "object",
    "title": "alarmGetGroups response",
    "properties": {
     "alarmGetGroups": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/AlarmGetGroupsResponseItem"
      }
     },
     "tag": {
      "description": "Echo of the request tag."
     }
    }
   },
   "AlarmCreateRequest": {
    "type": "object",
    "title": "alarmCreate request",
    "description": "Create a new alarm.",
    "required": [
     "alarmCreate"
    ],
    "properties": {
     "alarmCreate": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/AlarmCreateRequestItem"
      }
     },
     "whois": {
      "type": "string",
      "description": "Identification of the client (required for write access if the connection is not authenticated)."
     },
     "tag": {
      "description": "Any JSON value (except null), echoed in the response."
     }
    }
   },
   "AlarmCreateResponse": {
    "type": "object",
    "title": "alarmCreate response",
    "properties": {
     "alarmCreate": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/AlarmCreateResponseItem"
      }
     },
     "tag": {
      "description": "Echo of the request tag."
     }
    }
   },
   "AlarmReadRequest": {
    "type": "object",
    "title": "alarmRead request",
    "description": "Read the content of a specific alarm group.",
    "required": [
     "alarmRead"
    ],
    "properties": {
     "alarmRead": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/AlarmReadRequestItem"
      }
     },
     "whois": {
      "type": "string",
      "description": "Identification of the client (required for write access if the connection is not authenticated)."
     },
     "tag": {
      "description": "Any JSON value (except null), echoed in the response."
     }
    }
   },
   "AlarmReadResponse": {
    "type": "object",
    "title": "alarmRead response",
    "properties": {
     "alarmRead": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/AlarmReadResponseItem"
      }
     },
     "tag": {
      "description": "Echo of the request tag."
     }
    }
   },
   "AlarmAcknowledgeRequest": {
    "type": "object",
    "title": "alarmAcknowledge request",
    "description": "Acknowledge an alarm.",
    "required": [
     "alarmAcknowledge"
    ],
    "properties": {
     "alarmAcknowledge": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/AlarmAcknowledgeRequestItem"
      }
     },
     "whois": {
      "type": "string",
      "description": "Identification of the client (required for write access if the connection is not authenticated)."
     },
     "user": {
      "type": "string",
      "description": "User name."
     },
     "tag": {
      "description": "Any JSON value (except null), echoed in the response."
     }
    }
   },
   "AlarmAcknowledgeResponse": {
    "type": "object",
    "title": "alarmAcknowledge response",
    "properties": {
     "alarmAcknowledge": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/AlarmAcknowledgeResponseItem"
      }
     },
     "tag": {
      "description": "Echo of the request tag."
     }
    }
   },
   "AlarmCountRequest": {
    "type": "object",
    "title": "alarmCount request",
    "description": "Get counters of a specific alarm group.",
    "required": [
     "alarmCount"
    ],
    "properties": {
     "alarmCount": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/AlarmCountRequestItem"
      }
     },
     "whois": {
      "type": "string",
      "description": "Identification of the client (required for write access if the connection is not authenticated)."
     },
     "tag": {
      "description": "Any JSON value (except null), echoed in the response."
     }
    }
   },
   "AlarmCountResponse": {
    "type": "object",
    "title": "alarmCount response",
    "properties": {
     "alarmCount": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/AlarmCountResponseItem"
      }
     },
     "tag": {
      "description": "Echo of the request tag."
     }
    }
   },
   "AlarmSubscribeRequest": {
    "type": "object",
    "title": "alarmSubscribe request",
    "description": "Monitor alarms (WebSocket only).",
    "required": [
     "alarmSubscribe"
    ],
    "properties": {
     "alarmSubscribe": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/AlarmSubscribeRequestItem"
      }
     },
     "whois": {
      "type": "string",
      "description": "Identification of the client (required for write access if the connection is not authenticated)."
     },
     "tag": {
      "description": "Any JSON value (except null), echoed in the response."
     }
    }
   },
   "AlarmSubscribeResponse": {
    "type": "object",
    "title": "alarmSubscribe response",
    "properties": {
     "alarmSubscribe": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/AlarmSubscribeResponseItem"
      }
     },
     "tag": {
      "description": "Echo of the request tag."
     }
    }
   },
   "AlarmUnsubscribeRequest": {
    "type": "object",
    "title": "alarmUnsubscribe request",
    "description": "Unsubscribe monitored alarms (WebSocket only).",
    "required": [
     "alarmUnsubscribe"
    ],
    "properties": {
     "alarmUnsubscribe": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/AlarmUnsubscribeRequestItem"
      }
     },
     "whois": {
      "type": "string",
      "description": "Identification of the client (required for write access if the connection is not authenticated)."
     },
     "tag": {
      "description": "Any JSON value (except null), echoed in the response."
     }
    }
   },
   "AlarmUnsubscribeResponse": {
    "type": "object",
    "title": "alarmUnsubscribe response",
    "properties": {
     "alarmUnsubscribe": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/AlarmUnsubscribeResponseItem"
      }
     },
     "tag": {
      "description": "Echo of the request tag."
     }
    }
   },
   "AlarmSubscribeCountRequest": {
    "type": "object",
    "title": "alarmSubscribeCount request",
    "description": "Monitor alarm counters (WebSocket only).",
    "required": [
     "alarmSubscribeCount"
    ],
    "properties": {
     "alarmSubscribeCount": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/AlarmSubscribeCountRequestItem"
      }
     },
     "whois": {
      "type": "string",
      "description": "Identification of the client (required for write access if the connection is not authenticated)."
     },
     "tag": {
      "description": "Any JSON value (except null), echoed in the response."
     }
    }
   },
   "AlarmSubscribeCountResponse": {
    "type": "object",
    "title": "alarmSubscribeCount response",
    "properties": {
     "alarmSubscribeCount": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/AlarmSubscribeCountResponseItem"
      }
     },
     "tag": {
      "description": "Echo of the request tag."
     }
    }
   },
   "AlarmUnsubscribeCountRequest": {
    "type": "object",
    "title": "alarmUnsubscribeCount request",
    "description": "Unsubscribe monitored alarm counters (WebSocket only).",
    "required": [
     "alarmUnsubscribeCount"
    ],
    "properties": {
     "alarmUnsubscribeCount": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/AlarmUnsubscribeCountRequestItem"
      }
     },
     "whois": {
      "type": "string",
      "description": "Identification of the client (required for write access if the connection is not authenticated)."
     },
     "tag": {
      "description": "Any JSON value (except null), echoed in the response."
     }
    }
   },
   "AlarmUnsubscribeCountResponse": {
    "type": "object",
    "title": "alarmUnsubscribeCount response",
    "properties": {
     "alarmUnsubscribeCount": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/AlarmUnsubscribeCountResponseItem"
      }
     },
     "tag": {
      "description": "Echo of the request tag."
     }
    }
   },
   "VersionRequest": {
    "type": "object",
    "title": "version request",
    "description": "Get version information and capabilities of the DMS.",
    "required": [
     "version"
    ],
    "properties": {
     "version": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/VersionRequestItem"
      }
     },
     "whois": {
      "type": "string",
      "description": "Identification of the client (required for write access if the connection is not authenticated)."
     },
     "tag": {
      "description": "Any JSON value (except null), echoed in the response."
     }
    }
   },
   "VersionResponse": {
    "type": "object",
    "title": "version response",
    "properties": {
     "version": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/VersionResponseItem"
      }
     },
     "tag": {
      "description": "Echo of the request tag."
     }
    }
   },
   "InterpolateGetTemplatesRequest": {
    "type": "object",
    "title": "interpolateGetTemplates request",
    "description": "Get predefined interpolation parameter templates.",
    "required": [
     "interpolateGetTemplates"
    ],
    "properties": {
     "interpolateGetTemplates": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/InterpolateGetTemplatesRequestItem"
      }
     },
     "whois": {
      "type": "string",
      "description": "Identification of the client (required for write access if the connection is not authenticated)."
     },
     "tag": {
      "description": "Any JSON value (except null), echoed in the response."
     }
    }
   },
   "InterpolateGetTemplatesResponse": {
    "type": "object",
    "title": "interpolateGetTemplates response",
    "properties": {
     "interpolateGetTemplates": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/InterpolateGetTemplatesResponseItem"
      }
     },
     "tag": {
      "description": "Echo of the request tag."
     }
    }
   },
   "NodeReferencesRequest": {
    "type": "object",
    "title": "nodeReferences request",
    "description": "Get predefined node references.",
    "required": [
     "nodeReferences"
    ],
    "properties": {
     "nodeReferences": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/NodeRefRequestItem"
      }
     },
     "whois": {
      "type": "string",
      "description": "Identification of the client (required for write access if the connection is not authenticated)."
     },
     "tag": {
      "description": "Any JSON value (except null), echoed in the response."
     }
    }
   },
   "NodeReferencesResponse": {
    "type": "object",
    "title": "nodeReferences response",
    "properties": {
     "nodeReferences": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/NodeRefResponseItem"
      }
     },
     "tag": {
      "description": "Echo of the request tag."
     }
    }
   },
   "ValidateUserRequest": {
    "type": "object",
    "title": "validateUser request",
    "description": "Validate local ProMoS user(s).",
    "required": [
     "validateUser"
    ],
    "properties": {
     "validateUser": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/AuthValidateUserRequestItem"
      }
     }
    }
   },
   "ValidateUserResponse": {
    "type": "object",
    "title": "validateUser response",
    "properties": {
     "validateUser": {
      "type": "array",
      "items": {
       "$ref": "#/components/schemas/AuthValidateUserResponseItem"
      }
     },
     "tag": {
      "description": "Echo of the request tag."
     }
    }
   }
  },
  "securitySchemes": {
   "basicAuth": {
    "type": "http",
    "scheme": "basic",
    "description": "HTTP Basic authentication on secure connections (alternatively a client certificate)."
   }
  }
 },
 "security": [
  {},
  {
   "basicAuth": []
  }
 ],
 "x-promos": {
  "general": [
   {
    "title": "Overview",
    "body": "The ProMoS DMS JSON Data Exchange is the interface between external applications and the ProMoS data management system (DMS). It lets you read and write data points, read historical data, change logs and alarms, monitor data points and import/export data.\n\n- **Base path** for all data exchange: `/json_data` – for authentication: `/json_auth`.\n- **Ports** (configurable in the DMS communication properties): `9020` for HTTP/WebSocket, `9021` for HTTPS/WSS. Both are enabled by default.\n- **Request format:** a JSON object whose key is the command and whose value is an array of objects – e.g. `{\"get\": [{\"path\": \"EXMPL1:T11:MN:003:Vis:VMC_power\"}]}`. The response has the same structure, one result object per request object, in the same order.\n- All examples in this documentation show only the JSON content (HTTP body or WebSocket message payload).\n\n| Command | Group | Transport | Summary |\n|---|---|---|---|\n| `get` | Data Points | HTTP / WebSocket | Read data point values, query the DMS tree and read historical data. |\n| `set` | Data Points | HTTP / WebSocket | Write data point values, states, references or historical data (optionally creating data points). |\n| `rename` | Data Points | HTTP / WebSocket | Rename (move) data points or change the type of a data point. |\n| `copy` | Data Points | HTTP / WebSocket | Copy data points to a destination path. |\n| `updateBMO` | Data Points | HTTP / WebSocket | Balance (update) the DMS instances of a BMO object definition. |\n| `delete` | Data Points | HTTP / WebSocket | Delete data points or a range of their historical data. |\n| `subscribe` | Data Points | WebSocket | Monitor data points for changes (WebSocket only). |\n| `unsubscribe` | Data Points | WebSocket | Stop monitoring data points (WebSocket only). |\n| `verifyPcf` | Data Points | HTTP / WebSocket | Test a process control function (PCF) for a data point and return its result. |\n| `changelogGetGroups` | Change Logs | HTTP / WebSocket | Get all available change log groups. |\n| `changelogCreate` | Change Logs | HTTP / WebSocket (NG only) | Create a new change log entry. |\n| `changelogRead` | Change Logs | HTTP / WebSocket | Read the content of a specific change log group. |\n| `changelogCount` | Change Logs | HTTP / WebSocket (NG only) | Get counters of a specific change log group. |\n| `changelogSubscribe` | Change Logs | WebSocket (NG only) | Monitor a change log group (WebSocket only). |\n| `changelogUnsubscribe` | Change Logs | WebSocket (NG only) | Unsubscribe a monitored change log group (WebSocket only). |\n| `alarmGetGroups` | Alarms | HTTP / WebSocket (NG only) | Get all available alarm groups. |\n| `alarmCreate` | Alarms | HTTP / WebSocket (NG only) | Create a new alarm. |\n| `alarmRead` | Alarms | HTTP / WebSocket (NG only) | Read the content of a specific alarm group. |\n| `alarmAcknowledge` | Alarms | HTTP / WebSocket (NG only) | Acknowledge an alarm. |\n| `alarmCount` | Alarms | HTTP / WebSocket (NG only) | Get counters of a specific alarm group. |\n| `alarmSubscribe` | Alarms | WebSocket (NG only) | Monitor alarms (WebSocket only). |\n| `alarmUnsubscribe` | Alarms | WebSocket (NG only) | Unsubscribe monitored alarms (WebSocket only). |\n| `alarmSubscribeCount` | Alarms | WebSocket (NG only) | Monitor alarm counters (WebSocket only). |\n| `alarmUnsubscribeCount` | Alarms | WebSocket (NG only) | Unsubscribe monitored alarm counters (WebSocket only). |\n| `version` | System | HTTP / WebSocket (NG only) | Get version information and capabilities of the DMS. |\n| `interpolateGetTemplates` | Interpolation Templates | HTTP / WebSocket (NG only) | Get predefined interpolation parameter templates. |\n| `nodeReferences` | Node References | HTTP / WebSocket (NG only) | Get predefined node references. |\n| `validateUser` | Authentication | HTTP | Validate local ProMoS user(s). |"
   },
   {
    "title": "Transport: HTTP and WebSocket",
    "body": "All data is exchanged as JSON (UTF-8 encoded). Use real JSON data types – for boolean fields the string `\"FALSE\"` is evaluated as *true*.\n\nThere are two transport options, both available without or with SSL/TLS:\n\n- **HTTP(S) POST:** the JSON request is sent in the POST body (content type `application/json`), so request and response use the same encoding. Other HTTP methods are answered with `405`.\n- **WebSocket(S):** according to RFC 6455, version 13. PING/PONG and CLOSE control frames, fragmentation and masking are supported. Clients do not have to mask frames (optional). Larger responses are sent fragmented in frames of max. 8'192 characters of payload. Maximum received payload: 4 MB (4'194'304 characters) per frame and per message (sum of fragmented frames). The commands `subscribe`, `unsubscribe`, `changelogSubscribe` and `changelogUnsubscribe` are only available over WebSocket.\n\nUseful test tools are, for example, Apache JMeter (with WebSocket extension), REST clients such as Postman or Insomnia, and WebSocket clients for the browser."
   },
   {
    "title": "Security and authentication",
    "body": "**Insecure connections (HTTP/WS):** by default only local clients (127.0.0.1) may connect. For maximum performance in internal networks there is no authentication on insecure connections.\n\n**Secure connections (HTTPS/WSS):** by default, all non-local clients must connect via SSL/TLS and authenticate with a **client certificate** or with **HTTP Basic authentication**. If no valid client certificate is presented, the server requests Basic authentication.\n\n- **Server certificate:** the DMS sends a self-signed certificate with its domain name. The certificate files are regenerated automatically when they are removed and the DMS is restarted.\n- **Client certificate:** optional. Any received certificate is verified (issuer is the DMS, validity dates). The common name (CN) of the client certificate is used as user name and must be listed in the client users list together with the allowed serial number(s) (`clientname:serialnumber(s)`, several serial numbers separated by `,`, `*` for any). A client certificate can be created with OpenSSL (create key and CSR, sign it with the DMS certificate, convert it to PKCS#12).\n- **Basic authentication:** users are defined in a user list with password hashes in UNIX crypt(3) format (`username:$id$salt$hash`). Supported: `1` (MD5, not recommended), `apr1` (Apache MD5, not recommended), `5` (SHA-256), `6` (SHA-512).\n- **TLS settings:** by default only TLS 1.2 is allowed (older versions can be enabled, not recommended) and authentication is required on secure connections. The preferred cipher list can be configured.\n- **IP lists:** client IP addresses can be blocked or allowed separately for insecure and secure connections (CIDR notation). Blocked lists are evaluated first; if an allowed list exists, only the listed addresses are accepted.\n\nChanges to these configuration files require a restart of the DMS. On ProMoS NT (V1/V2) installations the files are located in the project configuration folder (`DMS_JSON_CLIENTS.cfg`, `DMS_JSON_USERS.cfg`, `DMS_JSON_IPS.cfg`, section `[SSL]` in `DMS.cfg`)."
   },
   {
    "title": "Request basics",
    "body": "- **Number of data points:** a single request can contain any number of data points. For performance reasons it is recommended to handle no more than 10'000 data points per request.\n- **Identification:** commands with write access (e.g. `set`, `rename`, `delete`) require the top-level field `whois` to identify the client. If the connection is authenticated (certificate or Basic authentication), `whois` is optional and the authenticated user name is used.\n- **Response order:** response arrays are ordered in the same way as the request arrays.\n- **Multiple commands:** it is recommended to send only one command per request. Several commands in one request are possible, but the processing order is not guaranteed (a JSON object is an unordered set of name/value pairs).\n- **Message tag:** besides the tags within the commands, a top-level `tag` object (any valid JSON value except `null`) can be sent; it is echoed in the response. For better readability, tags are not shown in the examples.\n- **Path length:** ProMoS NT 1.x: max. 80 characters, ProMoS NT 2.x: max. 160 characters, ProMoS NG: max. 64'000 characters. Longer paths are rejected.\n- **String arrays (ProMoS NT 1.x/2.x only):** indexed strings like `\"(11,12,13,14)\"` can be read and written with an index, e.g. `TEST:ARRAY[2]` (first index is 1, valid write range 1..1024). A type suffix after the closing bracket selects the data type: `BIT` (bool), `BYS`/`BYU`/`WOS`/`WOU`/`DWS`/`DWU` (int, default `DWU`), `FLT` (double), `STR` (string).\n\nExample with tag:\n\n```\n{\n  \"tag\": { \"reqnr\": 1456, \"flag\": true },\n  \"get\": [ { \"path\": \"EXMPL1:T11:MN:003:Vis:VMC_power\" } ]\n}\n```"
   },
   {
    "title": "Timestamps",
    "body": "All timestamps are ISO 8601 formatted.\n\n**From the DMS:** date/time with millisecond fraction and offset from UTC, e.g. `2015-03-20T08:49:19,000+01:00` (Europe/Zurich, CET) or `2015-04-28T09:10:11,000+02:00` (CEST, incl. daylight saving time). After a DMS restart a timestamp can be `null` (non-persistent storage); nodes without data (type `none`) return `null`.\n\n**To the DMS:** any valid ISO 8601 format can be used; recommended is UTC with millisecond fraction, e.g. `2015-04-28T07:10:11,023Z` or `2015-04-28T07:10:11Z`. Always add the UTC indicator `Z` or an offset from UTC – otherwise the DMS cannot evaluate the time zone of the sender."
   },
   {
    "title": "Error handling",
    "body": "- **HTTP POST:** fatal errors are returned with the usual HTTP status codes and a plain-text error message in the body (e.g. `405` with \"Use POST requests.\" for a GET request).\n- **WebSocket:** fatal errors close the connection with the usual WebSocket close codes (e.g. `1003 Unsupported Data`, reason \"Invalid path.\").\n- **Per data point:** each result object contains a `code` (e.g. `ok`, `no perm`, `not found`, `error`) and, if not `ok`, a human-readable `message` in English. If the request itself cannot be parsed, a single object `{\"code\": \"error\", \"message\": \"Expected JSON encoded data, but got something else.\"}` is returned."
   },
   {
    "title": "Node reference ids",
    "body": "| Id | Name | Description |\n|---|---|---|\n| 0 | DeviceSetpoint | Setpoint value on device |\n| 1 | DeviceInput | Only input value on device |\n| 2 | DeviceDigital | Digital value on device |\n\nThe table lists common ids; the full list is returned at runtime by the `nodeReferences` command."
   }
  ],
  "commands": [
   {
    "name": "get",
    "group": "Data Points",
    "transport": [
     "http",
     "ws"
    ],
    "ngOnly": false,
    "summary": "Read data point values, query the DMS tree and read historical data.",
    "description": "Reads one or more data point values. Any number of data points can be handled in one request; for performance it is recommended not to handle more than 10'000 data points at once. Response arrays are ordered like the request array. It is recommended to use only one command per request: with multiple commands in one body the processing order is not guaranteed. Maximum path length: 80 characters (ProMoS NT 1.x), 160 (ProMoS NT 2.x), 64'000 (ProMoS NG).\n\n**Short request:** for maximum performance the `get` array may contain plain path strings instead of objects (see `GetShortRequestItem`); the response is the normal response, field order not guaranteed.\n\n**Error:** on a fatal error (e.g. invalid JSON) the array contains a single object with `code` \"error\" and `message`.\n\n**Query (`query`):** searches paths/values starting at `path` (`\"\"` = root). RegEx uses Perl 5 syntax (PCRE 8.43, extended patterns allowed). `maxDepth` default 1 (current path), 0 = unlimited. Queries with more than 150'000 resulting data points are aborted with an error; use `limit` (max records, default internal maximum) and `offset` (number or starting path, default 0). When the limit is reached, the last record is `{\"code\":\"limitReached\",\"message\":\"Chosen limit reached\"|\"Memory limit reached\",\"limit\":<sent records>,\"nextOffset\":<number or path>}`. Changes in the DMS tree between calls (inserted/deleted nodes) can influence paging.\n\n**Historical data (`histData`):** combinable with `query`. Result limited to 610'000 entries (~17 years at 15 min or ~7 days at 1 s); refine start/end/interval. `showPast` returns changes in the past in an extra `histDataPast` array. Format \"compact\" returns `{\"<stamp>\": value}` objects, \"detail\" returns objects with stamp/value/state/rec.\n\n**Embedded change logs / alarms:** `changelogRead`, `changelogCount`, `alarmRead`, `alarmCount` can be embedded in a get item (definitions see the commands changelogRead, changelogCount, alarmRead and alarmCount). The get path is used as filter (overridable in the `filter` object), so counters include all child paths; for change logs `group` is optional and evaluated from the data point configuration. Result limited to 100'000 entries.\n\n**String arrays (ProMoS NT 1.x/2.x only, not NG):** a string like \"(11,12,13,14)\" can be indexed: reading \"TEST:ARRAY[2]\" returns 12; first index is 1. Reads outside existing index return an error. Default element type is uint (DWU); a suffix after \"]\" selects another type: BIT (bool), BYS/BYU/WOS/WOU/DWS/DWU ((u)int), FLT (double), STR (string).\n\n**Interpolation methods (only ProMoS NG, case insensitive)** - `interpolateMethod` is composed of method + parameters, e.g. `prevNextLinearFill`:\n\n| Method | Description | Possible parameters |\n|---|---|---|\n| prevNext | Previous and next values (away from the interval). `prevNextLinearFill` is how ProMoS NT sends values; usable for most values except consumption values. | Linear or Align, Fill/FillNull |\n| prev | Previous value. | Linear or Align, Fill/FillNull |\n| next | Next value. | Linear or Align, Fill/FillNull |\n| minMax | Lowest and highest values (visualizations). | Align, Fill/FillNull, Average |\n| min | Lowest value. | Align, Fill/FillNull |\n| max | Highest value. | Align, Fill/FillNull |\n| sum | Sum of the values (consumption values). | Linear or Align, Fill/FillNull |\n| meanA | Arithmetic mean. | Fill/FillNull |\n| meanG | Geometric mean. | Fill/FillNull |\n| meanH | Harmonic mean. | Fill/FillNull |\n| meanS | Root mean square (RMS). | Fill/FillNull |\n| median | Median (limit 1'000'000 values). | Fill/FillNull |\n| mode | Most frequent value (limit 1'000'000 values). | Fill/FillNull |\n| count | Number of data in the interval. | Fill/FillNull |\n\n| Parameter | Description |\n|---|---|\n| Linear | Values are linearly interpolated to the next requested interval timestamp (away from start by interval). |\n| Align | Value timestamps are adjusted to the next requested interval timestamp. |\n| Fill | Missing values in the interval are filled, depending on the method. |\n| FillNull | Missing values are returned as null (shows gaps in charts). |\n| Average | Only for minMax: average of min and max (e.g. WMO daily mean temperature). |\n\n| Additional prefix | Description |\n|---|---|\n| diff | Difference of the values (can be negative), calculated first; any other method can follow (default SumLinearFill). |\n| diffCtrUpCleaned | Difference, always positive; simple patterns like counter overflows are corrected. Calculated first; default SumLinearFill. |\n\n**Resulting timestamps:** raw values always carry the exact recording timestamp. By default values are retrospective (e.g. daily with start 2023-04-12T00:00+02:00: the first record at 2023-04-12T00:00 encloses 2023-04-11 00:00 - 23:59:59.999). For prevNext (without Linear) and minMax (without Average) two records are sent: the exact timestamp with the previous (or min) value and a record at +1 ms with the next (or max) value. Without Linear/Align the timestamp is that of the last value used for the calculation. mean*, median, mode and count are always Align.",
    "topLevelFields": [
     "tag"
    ],
    "requestItem": "GetRequestItem",
    "responseItem": "GetResponseItem",
    "eventItem": null,
    "examples": [
     {
      "title": "Read three data points",
      "request": {
       "get": [
        {
         "path": "EXMPL1:T11:MN:003:Vis:VMC_energy1"
        },
        {
         "path": "EXMPL1:T11:MN:003:Vis:VEnergy1V"
        },
        {
         "path": "EXMPL1:T11:MN:003:Vis:VMC_power"
        }
       ]
      },
      "response": {
       "get": [
        {
         "path": "EXMPL1:T11:MN:003:Vis:VMC_energy1",
         "code": "ok",
         "type": "double",
         "value": 3.0,
         "stamp": "2015-03-20T07:49:19,000+01:00"
        },
        {
         "path": "EXMPL1:T11:MN:003:Vis:VEnergy1V",
         "code": "ok",
         "type": "double",
         "value": 0.0,
         "stamp": "2015-03-20T07:49:19,000+01:00"
        },
        {
         "path": "EXMPL1:T11:MN:003:Vis:VMC_power",
         "code": "ok",
         "type": "double",
         "value": 0.597,
         "stamp": "2015-03-20T07:49:19,000+01:00"
        }
       ]
      }
     },
     {
      "title": "Fatal error response",
      "request": null,
      "response": {
       "get": [
        {
         "code": "error",
         "message": "Expected JSON encoded data, but got something else."
        }
       ]
      }
     },
     {
      "title": "Short request",
      "request": {
       "get": [
        "EXMPL1:T11:MN:003:Vis:VMC_energy1",
        "EXMPL1:T11:MN:003:Vis:VEnergy1V",
        "EXMPL1:T11:MN:003:Vis:VMC_power"
       ]
      },
      "response": null
     },
     {
      "title": "Query whole DMS with limit/offset",
      "request": {
       "get": [
        {
         "path": "",
         "query": {
          "maxDepth": 0,
          "limit": 100,
          "offset": 0
         }
        }
       ]
      },
      "response": {
       "get": [
        {
         "path": "",
         "code": "ok",
         "type": "none",
         "value": null,
         "stamp": "2015-03-20T07:49:19,000+01:00",
         "readonly": true,
         "hasChild": true
        },
        {
         "code": "limitReached",
         "message": "Chosen limit reached",
         "limit": 100,
         "nextOffset": 200
        }
       ]
      }
     },
     {
      "title": "Query examples",
      "request": {
       "get": [
        {
         "path": "",
         "query": {
          "regExPath": "^(?!(BMO|System)).*$",
          "maxDepth": 0
         }
        },
        {
         "path": "EXMPL1:T11",
         "query": {
          "regExPath": ".*:Istwert",
          "regExValue": "[0]",
          "maxDepth": 0
         }
        },
        {
         "path": "",
         "query": {
          "regExValue": "true",
          "isType": "bool",
          "maxDepth": 0
         }
        },
        {
         "path": "EXMPL1:T11",
         "query": {
          "hasHistData": true,
          "maxDepth": 0
         }
        }
       ]
      },
      "response": null
     },
     {
      "title": "Historical data of all data points with recording (query + histData)",
      "request": {
       "get": [
        {
         "path": "",
         "query": {
          "hasHistData": true,
          "maxDepth": 0
         },
         "histData": {
          "start": "2015-04-04T00:00:00Z",
          "end": "2015-04-05T00:00:00Z",
          "interval": 900,
          "format": "detail"
         }
        }
       ]
      },
      "response": null
     },
     {
      "title": "Historical data, compact format",
      "request": {
       "get": [
        {
         "path": "System:NT:Perf:SYSTEM",
         "histData": {
          "start": "2015-04-01T00:00:00Z",
          "interval": 100
         }
        }
       ]
      },
      "response": {
       "get": [
        {
         "path": "System:NT:Perf:SYSTEM",
         "code": "ok",
         "type": "double",
         "value": 0.0,
         "stamp": null,
         "histData": [
          {
           "2015-04-03T04:33:20,000+02:00": 0.32780084013938904
          },
          {
           "2015-04-03T04:35:00,000+02:00": 0.7427386045455933
          },
          {
           "2015-04-17T08:37:40,000+02:00": 0.6244444251060486
          }
         ]
        }
       ]
      }
     },
     {
      "title": "Historical data, detail format",
      "request": {
       "get": [
        {
         "path": "System:NT:Perf:DMS",
         "histData": {
          "start": "2015-01-01T00:00:00Z",
          "end": "2015-05-31T00:00:00Z",
          "format": "detail"
         }
        }
       ]
      },
      "response": {
       "get": [
        {
         "path": "System:NT:Perf:DMS",
         "code": "ok",
         "type": "double",
         "value": 0.0,
         "stamp": null,
         "histData": [
          {
           "stamp": "2015-04-03T04:45:00,000+02:00",
           "value": 0.0,
           "state": "ok",
           "rec": "cycle"
          },
          {
           "stamp": "2015-04-03T05:00:00,000+02:00",
           "value": 0.0,
           "state": "ok",
           "rec": "cycle"
          }
         ]
        }
       ]
      }
     },
     {
      "title": "Child query (ProMoS NG)",
      "request": {
       "get": [
        {
         "path": "",
         "query": {
          "maxDepth": 0,
          "childs": [
           {
            "pathPart": "_DeviceName",
            "value": "Device-50012",
            "valueCompare": "eq"
           },
           {
            "pathPart": "object-type",
            "value": "calendar (",
            "valueCompare": "startsWith"
           },
           {
            "pathPart": "date-list-jext",
            "return": true
           }
          ]
         }
        }
       ]
      },
      "response": null
     },
     {
      "title": "Historical data with filter and normalization (ProMoS NG)",
      "request": {
       "get": [
        {
         "path": "EXMPL1:Room1:Temp",
         "histData": {
          "start": "2023-03-20T00:00:00,000+01:00",
          "interval": -1,
          "interpolateMethod": "meanA",
          "filterParams": [
           {
            "timeStart": "22:00:00",
            "duration": 7200,
            "weekDays": [
             1,
             2,
             3,
             4,
             5
            ]
           },
           {
            "timeStart": "00:00:00",
            "duration": 7200,
            "weekDays": [
             2,
             3,
             4,
             5,
             6
            ]
           }
          ],
          "normalizeParams": [
           {
            "method": "prevNextLinearFill",
            "interval": 900
           }
          ]
         }
        }
       ]
      },
      "response": null
     }
    ]
   },
   {
    "name": "set",
    "group": "Data Points",
    "transport": [
     "http",
     "ws"
    ],
    "ngOnly": false,
    "summary": "Write data point values, states, references or historical data (optionally creating data points).",
    "description": "Writes one or more data points. Any number of data points can be handled in one request; for performance it is recommended not to handle more than 10'000 data points at once. Response arrays are ordered like the request array. It is recommended to use only one command per request: with multiple commands in one body the processing order is not guaranteed. Maximum path length: 80 characters (ProMoS NT 1.x), 160 (ProMoS NT 2.x), 64'000 (ProMoS NG). Write commands require identification via the top-level \"whois\" field; when the connection is authenticated (certificate or Basic Auth), \"whois\" is optional and the authenticated user name is used.\n\nTop-level fields: `whois` (sender identification, e.g. \"sDriver\"; mandatory unless authenticated), `user` (logged-in user name, empty when none; marked mandatory), `suppressSetOkObject` (optional boolean: when true, no response object is generated for code \"ok\", reducing traffic).\n\n**Type evaluation:** without `type`, the internal type is derived from the JSON type: string -> string, true/false -> bool, 123 -> int, 123.0/123.4 -> double. Because some JSON writers send 123.0 as 123, writing an int to an existing double data point is allowed. But creating a data point with `\"create\": true` and value 123 without `type` creates an int data point - send `\"type\":\"double\"` to be sure.\n\n**Write historical data:** send `histData` (compact `{\"<stamp>\": value}` entries with state ok, detailed `{stamp,value,state}` entries, or mixed). A historical data configuration is created if none exists. Large arrays can be slow, especially in the past on ProMoS 1/2 (about 10 s or more for 10'000 values).\n\n**String arrays (ProMoS NT 1.x/2.x only):** writing \"TEST:ARRAY[4]\" sets that element of an array string; valid index range 1..1024, writing beyond the existing size expands the array, filling new elements with NULL.\n\n**Mandatory fields:** `path` (or `id`) is mandatory; `value` is mandatory unless `state`, `refs` or `histData` is sent; `type` is optional.",
    "topLevelFields": [
     "whois",
     "user",
     "suppressSetOkObject",
     "tag"
    ],
    "requestItem": "SetRequestItem",
    "responseItem": "SetResponseItem",
    "eventItem": null,
    "examples": [
     {
      "title": "Write values",
      "request": {
       "whois": "DriverXY",
       "user": "",
       "set": [
        {
         "path": "EXMPL1:T11:MN:003:Vis:VMC_energy1",
         "value": 4.4565467567867,
         "type": "double"
        },
        {
         "path": "EXMPL1:T11:MN:003:Vis:VEnergy1V",
         "value": -1,
         "type": "double",
         "stamp": "2015-03-11T05:27:39,027+01:00"
        },
        {
         "path": "EXMPL1:TEST:BOOLEAN",
         "value": true,
         "create": true,
         "type": "bool"
        },
        {
         "path": "EXMPL1:TEST:INT",
         "value": 44,
         "type": "int"
        },
        {
         "path": "EXMPL1:TEST:STRING",
         "value": "some long example message",
         "type": "string"
        }
       ]
      },
      "response": {
       "set": [
        {
         "code": "ok",
         "path": "EXMPL1:T11:MN:003:Vis:VMC_energy1",
         "value": 3,
         "type": "double",
         "stamp": "2015-03-20T07:49:19,000+01:00"
        },
        {
         "code": "ok",
         "path": "EXMPL1:T11:MN:003:Vis:VEnergy1V",
         "value": 0,
         "type": "double",
         "stamp": "2015-03-11T05:27:39,027+01:00"
        },
        {
         "code": "no perm",
         "path": "EXMPL1:TEST:BOOLEAN"
        },
        {
         "code": "error",
         "path": "EXMPL1:TEST:INT",
         "message": "Data point doesn't exist"
        },
        {
         "code": "error",
         "path": "EXMPL1:TEST:STRING",
         "message": "Data type doesn't match"
        }
       ]
      }
     },
     {
      "title": "Write historical data (mixed compact/detail)",
      "request": {
       "whois": "DriverXY",
       "user": "",
       "set": [
        {
         "path": "EXMPL1:T11:MN:003:Vis:VMC_energy1",
         "histData": [
          {
           "2015-04-03T04:33:20,000+02:00": 0.32780084013938904
          },
          {
           "2015-04-03T04:35:00,000+02:00": 0.7427386045455933
          },
          {
           "stamp": "2015-04-03T04:37:00,000+02:00",
           "value": 0.5,
           "state": "inv"
          },
          {
           "2015-04-17T08:37:40,000+02:00": 0.6244444251060486
          }
         ]
        }
       ]
      },
      "response": {
       "set": [
        {
         "code": "ok",
         "path": "EXMPL1:T11:MN:003:Vis:VMC_energy1"
        }
       ]
      }
     },
     {
      "title": "Write node references (ProMoS NG)",
      "request": {
       "whois": "DriverXY",
       "user": "",
       "set": [
        {
         "path": "EXMPL1:Room1:Temp",
         "refs": [
          {
           "id": 1,
           "value": true
          },
          {
           "id": 3478,
           "value": {
            "test": 1
           }
          }
         ]
        }
       ]
      },
      "response": null
     },
     {
      "title": "Multiple commands in one request (order not guaranteed)",
      "request": {
       "whois": "DriverXY",
       "user": "",
       "set": [
        {
         "path": "EXMPL1:T11:MN:003:Vis:VMC_power",
         "value": 4.4444
        }
       ],
       "get": [
        {
         "path": "EXMPL1:T11:MN:003:Vis:VMC_power"
        }
       ]
      },
      "response": {
       "get": [
        {
         "path": "EXMPL1:T11:MN:003:Vis:VMC_power",
         "code": "ok",
         "type": "double",
         "value": 1.1111,
         "stamp": "2015-03-20T04:23:44,000+01:00"
        }
       ],
       "set": [
        {
         "path": "EXMPL1:T11:MN:003:Vis:VMC_power",
         "code": "ok",
         "type": "double",
         "value": 4.4444,
         "stamp": "2015-03-20T07:49:19,000+01:00"
        }
       ]
      }
     }
    ]
   },
   {
    "name": "rename",
    "group": "Data Points",
    "transport": [
     "http",
     "ws"
    ],
    "ngOnly": false,
    "summary": "Rename (move) data points or change the type of a data point.",
    "description": "Renames one or more data points from `path` to `newPath`. To change only the type of a value, use the same `path` and `newPath` with the desired `type`. Write commands require identification via the top-level \"whois\" field; when the connection is authenticated (certificate or Basic Auth), \"whois\" is optional and the authenticated user name is used. On subscribed data points a rename generates the events onRename, onDelete and onCreate.",
    "topLevelFields": [
     "whois",
     "tag"
    ],
    "requestItem": "RenameRequestItem",
    "responseItem": "RenameResponseItem",
    "eventItem": null,
    "examples": [
     {
      "title": "Rename data points",
      "request": {
       "whois": "DriverXY",
       "rename": [
        {
         "path": "EXMPL1:T11:MN:003",
         "newPath": "EXMPL1:T11:MN:002"
        },
        {
         "path": "EXMPL1:T11:MN:003",
         "newPath": "EXMPL1:T11:MN:002"
        }
       ]
      },
      "response": {
       "rename": [
        {
         "code": "ok",
         "path": "EXMPL1:T11:MN:003",
         "newPath": "EXMPL1:T11:MN:002"
        },
        {
         "code": "not found",
         "path": "EXMPL1:T11:MN:003",
         "message": "Data point doesn't exist"
        }
       ]
      }
     }
    ]
   },
   {
    "name": "copy",
    "group": "Data Points",
    "transport": [
     "http",
     "ws"
    ],
    "ngOnly": false,
    "summary": "Copy data points to a destination path.",
    "description": "Copies one or more data points from `path` to `destPath`. Fails with code \"error\" (e.g. \"Could not copy, destPath exists\") when the destination exists. Write commands require identification via the top-level \"whois\" field; when the connection is authenticated (certificate or Basic Auth), \"whois\" is optional and the authenticated user name is used.",
    "topLevelFields": [
     "whois",
     "tag"
    ],
    "requestItem": "CopyRequestItem",
    "responseItem": "CopyResponseItem",
    "eventItem": null,
    "examples": [
     {
      "title": "Copy data points",
      "request": {
       "whois": "DriverXY",
       "copy": [
        {
         "path": "EXMPL1:T11:MN:003",
         "destPath": "EXMPL1:T11:MN:002"
        },
        {
         "path": "EXMPL1:T11:MN:003",
         "destPath": "EXMPL1:T11:MN:002"
        }
       ]
      },
      "response": {
       "copy": [
        {
         "code": "ok",
         "path": "EXMPL1:T11:MN:003",
         "destPath": "EXMPL1:T11:MN:002"
        },
        {
         "code": "error",
         "path": "EXMPL1:T11:MN:003",
         "destPath": "EXMPL1:T11:MN:002",
         "message": "Could not copy, destPath exists"
        }
       ]
      }
     }
    ]
   },
   {
    "name": "updateBMO",
    "group": "Data Points",
    "transport": [
     "http",
     "ws"
    ],
    "ngOnly": false,
    "summary": "Balance (update) the DMS instances of a BMO object definition.",
    "description": "Balances data points of a BMO object (`object`) in the DMS tree. ProMoS NG options: `excludeDeletions` (path parts that must not be deleted on the target; [\"*\"] = no deletions) and `updateValues` (path parts whose values are updated; [\"*\"] = all; default [\"Vers_\", \"PRG\"]). Write commands require identification via the top-level \"whois\" field; when the connection is authenticated (certificate or Basic Auth), \"whois\" is optional and the authenticated user name is used.",
    "topLevelFields": [
     "whois",
     "tag"
    ],
    "requestItem": "UpdateBmoRequestItem",
    "responseItem": "UpdateBmoResponseItem",
    "eventItem": null,
    "examples": [
     {
      "title": "Update BMO object",
      "request": {
       "whois": "DriverXY",
       "updateBMO": [
        {
         "object": "MOT01"
        }
       ]
      },
      "response": {
       "updateBMO": [
        {
         "code": "ok",
         "object": "MOT01"
        }
       ]
      }
     }
    ]
   },
   {
    "name": "delete",
    "group": "Data Points",
    "transport": [
     "http",
     "ws"
    ],
    "ngOnly": false,
    "summary": "Delete data points or a range of their historical data.",
    "description": "Deletes one or more data points. With `recursive: true` sub paths are deleted as well; otherwise deleting a data point with sub paths returns code \"error\" with message \"Path is not empty\".\n\n**Delete historical data:** send `histData` with `start` and `end` to delete that range of historical data; the data point itself is then not deleted.\n\nWrite commands require identification via the top-level \"whois\" field; when the connection is authenticated (certificate or Basic Auth), \"whois\" is optional and the authenticated user name is used.",
    "topLevelFields": [
     "whois",
     "user",
     "tag"
    ],
    "requestItem": "DeleteRequestItem",
    "responseItem": "DeleteResponseItem",
    "eventItem": null,
    "examples": [
     {
      "title": "Delete data points",
      "request": {
       "whois": "DriverXY",
       "delete": [
        {
         "path": "EXMPL1:T11:MN:003"
        },
        {
         "path": "EXMPL1:T11:MN:003",
         "recursive": true
        },
        {
         "path": "EXMPL1:T11:MN:003:Vis:VEnergy1V"
        },
        {
         "path": "EXMPL1:TEST:BOOLEAN"
        }
       ]
      },
      "response": {
       "delete": [
        {
         "code": "error",
         "path": "EXMPL1:T11:MN:003",
         "message": "Path is not empty"
        },
        {
         "code": "ok",
         "path": "EXMPL1:T11:MN:003"
        },
        {
         "code": "not found",
         "path": "EXMPL1:T11:MN:003:Vis:VEnergy1V",
         "message": "Data point doesn't exist"
        },
        {
         "code": "ok",
         "path": "EXMPL1:TEST:BOOLEAN"
        }
       ]
      }
     },
     {
      "title": "Delete historical data range",
      "request": {
       "whois": "DriverXY",
       "user": "",
       "delete": [
        {
         "path": "EXMPL1:T11:MN:003:Vis:VMC_energy1",
         "histData": {
          "start": "2015-04-04T00:00:00Z",
          "end": "2015-04-05T00:00:00Z"
         }
        }
       ]
      },
      "response": {
       "delete": [
        {
         "code": "ok",
         "path": "EXMPL1:T11:MN:003:Vis:VMC_energy1"
        }
       ]
      }
     }
    ]
   },
   {
    "name": "subscribe",
    "group": "Data Points",
    "transport": [
     "ws"
    ],
    "ngOnly": false,
    "summary": "Monitor data points for changes (WebSocket only).",
    "description": "Subscribes to events of one or more data points. **Only on WebSocket connections.** After loss of the WebSocket connection all monitoring configurations are cleared; the client must re-subscribe.\n\n- `event`: one or more of onChange, onSet, onCreate, onRename, onDelete or \"*\" (comma separated string or array); default onChange.\n- `query` (same object as for get) is evaluated at the time of the event, e.g. `maxDepth: 0` monitors a whole sub tree.\n- Multiple subscriptions on the same path are possible with different `tag`s; a subscription with the same path and tag on the same connection overwrites the previous one. Unsubscribe with the same path and tag.\n- Events are delivered asynchronously as messages `{\"event\":[...]}` (see `EventItem`); an event can arrive between a subscribe request and its response. A rename generates onRename, onDelete and onCreate.\n- ProMoS NG: `suppressSubscribeOkObject` suppresses ok response objects; `suppressOwnEvents` suppresses events triggered by the same WebSocket participant (overwritten by any later subscribe).",
    "topLevelFields": [
     "tag"
    ],
    "requestItem": "SubscribeRequestItem",
    "responseItem": "SubscribeResponseItem",
    "eventItem": "EventItem",
    "examples": [
     {
      "title": "Subscribe to the System tree (response and a later event message in \"event\")",
      "request": {
       "subscribe": [
        {
         "path": "System",
         "event": "onChange",
         "query": {
          "maxDepth": 0
         }
        }
       ]
      },
      "response": {
       "subscribe": [
        {
         "code": "ok",
         "path": "System",
         "type": "none",
         "value": null,
         "stamp": null,
         "event": "onChange",
         "query": {
          "maxDepth": 0
         }
        }
       ]
      },
      "event": {
       "event": [
        {
         "code": "onChange",
         "path": "System:Blinker:Blink0.25",
         "trigger": "<SYS>",
         "type": "bool",
         "value": true,
         "stamp": "2015-05-27T08:13:58,521+02:00"
        },
        {
         "code": "onChange",
         "path": "System:Blinker:Blink0.5",
         "trigger": "<SYS>",
         "type": "bool",
         "value": false,
         "stamp": "2015-05-27T08:13:58,521+02:00"
        }
       ]
      }
     }
    ]
   },
   {
    "name": "unsubscribe",
    "group": "Data Points",
    "transport": [
     "ws"
    ],
    "ngOnly": false,
    "summary": "Stop monitoring data points (WebSocket only).",
    "description": "Removes a subscription previously created with `subscribe`. Send the same `path` and `tag` as used on subscription. Only on WebSocket connections. The response items have the same structure as the subscribe response.",
    "topLevelFields": [
     "tag"
    ],
    "requestItem": "UnsubscribeRequestItem",
    "responseItem": "SubscribeResponseItem",
    "eventItem": null,
    "examples": [
     {
      "title": "Unsubscribe",
      "request": {
       "unsubscribe": [
        {
         "path": "System"
        }
       ]
      },
      "response": null
     }
    ]
   },
   {
    "name": "verifyPcf",
    "group": "Data Points",
    "transport": [
     "http",
     "ws"
    ],
    "ngOnly": false,
    "summary": "Test a process control function (PCF) for a data point and return its result.",
    "description": "Evaluates the given process control function `pcf` for the data point `path` without storing it. `message` contains any evaluation or calculation error (empty string = no error); `result` contains the PCF result when one could be produced. On a fatal error (e.g. invalid JSON) a single object with code \"error\" and message is returned.",
    "topLevelFields": [
     "tag"
    ],
    "requestItem": "VerifyPcfRequestItem",
    "responseItem": "VerifyPcfResponseItem",
    "eventItem": null,
    "examples": [
     {
      "title": "Verify a JSE process control function",
      "request": {
       "verifyPcf": [
        {
         "path": "EXMPL1:T11:MN:003:Vis:VMC_energy1",
         "pcf": "JSE ( function() { if (@{EXMPL1:Room1:Temp} < 10.0) return true; else return false; })"
        }
       ]
      },
      "response": {
       "verifyPcf": [
        {
         "path": "EXMPL1:T11:MN:003:Vis:VMC_energy1",
         "code": "ok",
         "message": "",
         "result": true
        }
       ]
      }
     },
     {
      "title": "Fatal error response",
      "request": null,
      "response": {
       "verifyPcf": [
        {
         "code": "error",
         "message": "Expected JSON encoded data, but got something else."
        }
       ]
      }
     }
    ]
   },
   {
    "transport": [
     "http",
     "ws"
    ],
    "ngOnly": false,
    "basePath": "/json_data",
    "topLevelFields": [
     "whois",
     "tag"
    ],
    "eventItem": null,
    "name": "changelogGetGroups",
    "group": "Change Logs",
    "summary": "Get all available change log groups.",
    "description": "Returns all change log group names that can be used with `changelogRead`. Any data point can have a change log (see `hasChangelog` in the data point query object); change logs are grouped by name.\n\nThe request array is empty.",
    "requestItem": "ChangelogGetGroupsRequestItem",
    "responseItem": "ChangelogGetGroupsResponseItem",
    "examples": [
     {
      "title": "Get change log groups",
      "request": {
       "changelogGetGroups": []
      },
      "response": {
       "changelogGetGroups": [
        {
         "code": "ok",
         "groups": [
          "login",
          "Ereign1",
          "Alarm",
          "Manip1"
         ]
        }
       ]
      }
     }
    ]
   },
   {
    "transport": [
     "http",
     "ws"
    ],
    "ngOnly": true,
    "basePath": "/json_data",
    "topLevelFields": [
     "whois",
     "tag"
    ],
    "eventItem": null,
    "name": "changelogCreate",
    "group": "Change Logs",
    "summary": "Create a new change log entry.",
    "description": "Creates a change log entry for a data point (identified by `path` or `id`) in the given change log group. Returns the unique id of the new entry.\n\nOnly ProMoS NG.",
    "requestItem": "ChangelogCreateRequestItem",
    "responseItem": "ChangelogCreateResponseItem",
    "examples": [
     {
      "title": "Create change log entry",
      "request": {
       "whois": "Client",
       "changelogCreate": [
        {
         "group": "Manip1",
         "path": "EXMPL1:Room1:Test",
         "stamp": "2021-11-03T16:20:48,767+01:00",
         "user": "operator",
         "oldValue": "0",
         "newValue": "1",
         "text": "Test",
         "siteGroup": 0
        }
       ]
      },
      "response": {
       "changelogCreate": [
        {
         "code": "ok",
         "id": "EXMPL1:Room1:Test|1"
        }
       ]
      }
     }
    ]
   },
   {
    "transport": [
     "http",
     "ws"
    ],
    "ngOnly": false,
    "basePath": "/json_data",
    "topLevelFields": [
     "whois",
     "tag"
    ],
    "eventItem": null,
    "name": "changelogRead",
    "group": "Change Logs",
    "summary": "Read the content of a specific change log group.",
    "description": "Reads change log records of a group within a time period.\n\n- The resulting response array is limited to max. **100'000** entries; refine the period (start/end, filters) to receive the desired data.\n- With `limit`/`offset` the result can be paged; when the limit is reached, `changelogLimitReached: true` is returned.\n- `start`/`end` keywords (\"first\", \"last\", \"now\"), `filter`, `format` and `locale` are ProMoS NG only.\n\nFilter object (ProMoS NG):\n\n| Filter member | Type | Description |\n|---|---|---|\n| path | string | Path to filter - partial match |\n| text | string | Text to filter - partial match |\n| siteGroup | array of numbers | Site groups |\n| user | string | User entry - partial match |",
    "requestItem": "ChangelogReadRequestItem",
    "responseItem": "ChangelogReadResponseItem",
    "examples": [
     {
      "title": "Read change log for a period",
      "request": {
       "changelogRead": [
        {
         "group": "ABS1",
         "start": "2016-02-29T00:00:00Z",
         "end": "2016-03-02T00:00:00Z"
        }
       ]
      },
      "response": {
       "changelogRead": [
        {
         "code": "ok",
         "group": "ABS1",
         "changelog": [
          {
           "id": "EXMPL1:Heating:Valve1:ABS_Ein|0|165382260",
           "path": "EXMPL1:Heating:Valve1:ABS_Ein",
           "stamp": "2016-02-29T11:48:55,715+01:00",
           "text": "Heating valve off"
          },
          {
           "id": "EXMPL1:Heating:Valve1:ABS_Ein|0|165337860",
           "path": "EXMPL1:Heating:Valve1:ABS_Ein",
           "stamp": "2016-02-29T11:42:58,197+01:00",
           "text": "Heating valve on"
          }
         ]
        }
       ]
      }
     }
    ]
   },
   {
    "transport": [
     "http",
     "ws"
    ],
    "ngOnly": true,
    "basePath": "/json_data",
    "topLevelFields": [
     "whois",
     "tag"
    ],
    "eventItem": null,
    "name": "changelogCount",
    "group": "Change Logs",
    "summary": "Get counters of a specific change log group.",
    "description": "Reads counters (total number of entries) for the given change log group, time period and filter. Only on ProMoS NG. The filter object is the same as for `changelogRead`.",
    "requestItem": "ChangelogCountRequestItem",
    "responseItem": "ChangelogCountResponseItem",
    "examples": [
     {
      "title": "Count change log entries",
      "request": {
       "changelogCount": [
        {
         "group": "Manip1",
         "start": "2016-02-29T00:00:00Z",
         "end": "2016-03-02T00:00:00Z"
        }
       ]
      },
      "response": {
       "changelogCount": [
        {
         "code": "ok",
         "group": "Manip1",
         "countTotal": 165
        }
       ]
      }
     }
    ]
   },
   {
    "transport": [
     "ws"
    ],
    "ngOnly": true,
    "basePath": "/json_data",
    "topLevelFields": [
     "whois",
     "tag"
    ],
    "eventItem": "ChangelogEventItem",
    "name": "changelogSubscribe",
    "group": "Change Logs",
    "summary": "Monitor a change log group (WebSocket only).",
    "description": "Subscribes to changes of a change log group. Only for WebSocket connections on ProMoS NG.\n\n- The subscription is unique for the given `group`, `tag` and WebSocket connection; a further subscription with the same group and tag overrides the existing one.\n- After loss of the WebSocket connection the client has to re-subscribe.\n- Events are sent as `{\"eventChangelog\": [ ... ]}` with one or more entries; `code` is the trigger (`onCreate`, `onChange`, `onDelete`).",
    "requestItem": "ChangelogSubscribeRequestItem",
    "responseItem": "ChangelogSubscribeResponseItem",
    "examples": [
     {
      "title": "Subscribe to a change log group",
      "request": {
       "changelogSubscribe": [
        {
         "group": "ABS1"
        }
       ]
      },
      "response": {
       "changelogSubscribe": [
        {
         "code": "ok",
         "group": "ABS1"
        }
       ]
      }
     }
    ]
   },
   {
    "transport": [
     "ws"
    ],
    "ngOnly": true,
    "basePath": "/json_data",
    "topLevelFields": [
     "whois",
     "tag"
    ],
    "eventItem": null,
    "name": "changelogUnsubscribe",
    "group": "Change Logs",
    "summary": "Unsubscribe a monitored change log group (WebSocket only).",
    "description": "Removes a subscription created with `changelogSubscribe`. `group` and `tag` must match the subscription. Only for WebSocket connections on ProMoS NG.",
    "requestItem": "ChangelogUnsubscribeRequestItem",
    "responseItem": "ChangelogUnsubscribeResponseItem",
    "examples": [
     {
      "title": "Unsubscribe",
      "request": {
       "changelogUnsubscribe": [
        {
         "group": "ABS1"
        }
       ]
      },
      "response": {
       "changelogUnsubscribe": [
        {
         "code": "ok",
         "group": "ABS1"
        }
       ]
      }
     }
    ]
   },
   {
    "transport": [
     "http",
     "ws"
    ],
    "ngOnly": true,
    "basePath": "/json_data",
    "topLevelFields": [
     "whois",
     "tag"
    ],
    "eventItem": null,
    "name": "alarmGetGroups",
    "group": "Alarms",
    "summary": "Get all available alarm groups.",
    "description": "All alarm functionality is ProMoS NG only. Returns all alarm group names usable with `alarmRead`. Any data point can have one or more alarms (see `hasAlarmData` in the data point query object). Default alarm groups are \"Alarm\" (priority 0-5 in ProMoS NT) and \"Service\" (priority 6 in ProMoS NT).\n\nThe request array is empty.",
    "requestItem": "AlarmGetGroupsRequestItem",
    "responseItem": "AlarmGetGroupsResponseItem",
    "examples": [
     {
      "title": "Get alarm groups",
      "request": {
       "alarmGetGroups": []
      },
      "response": {
       "alarmGetGroups": [
        {
         "code": "ok",
         "groups": [
          "Alarm",
          "Service"
         ]
        }
       ]
      }
     }
    ]
   },
   {
    "transport": [
     "http",
     "ws"
    ],
    "ngOnly": true,
    "basePath": "/json_data",
    "topLevelFields": [
     "whois",
     "tag"
    ],
    "eventItem": null,
    "name": "alarmCreate",
    "group": "Alarms",
    "summary": "Create a new alarm.",
    "description": "All alarm functionality is ProMoS NG only. Creates an alarm entry for a data point (identified by `path` or `id`). `group` and `priority` are mandatory. Returns the unique alarm id.\n\nAlarm states: `occurred`, `left`, `acknowledged`, `leftAcknowledged`.",
    "requestItem": "AlarmCreateRequestItem",
    "responseItem": "AlarmCreateResponseItem",
    "examples": [
     {
      "title": "Create alarm",
      "request": {
       "whois": "AlarmViewer",
       "alarmCreate": [
        {
         "group": "Alarm",
         "path": "EXMPL1:Room1:AirQuality:GW_LE_Err",
         "stamp": "2021-11-03T16:20:48,767+01:00",
         "user": "operator",
         "oldValue": "0",
         "newValue": "1",
         "text": "Air quality lower limit reached",
         "state": "acknowledged",
         "priority": 2,
         "priorityDevice": 0,
         "alarmGroup": 1,
         "alarmCollectGroup": 0,
         "siteGroup": 0
        }
       ]
      },
      "response": {
       "alarmCreate": [
        {
         "code": "ok",
         "id": "EXMPL1:Room1:AirQuality:GW_LE_Err|1"
        }
       ]
      }
     }
    ]
   },
   {
    "transport": [
     "http",
     "ws"
    ],
    "ngOnly": true,
    "basePath": "/json_data",
    "topLevelFields": [
     "whois",
     "tag"
    ],
    "eventItem": null,
    "name": "alarmRead",
    "group": "Alarms",
    "summary": "Read the content of a specific alarm group.",
    "description": "All alarm functionality is ProMoS NG only. Reads alarm records (pending and/or historical) of a group within a time period.\n\n- The resulting response array is limited to max. **100'000** entries; refine the period (start/end, filters) to receive the desired data.\n- With `limit`/`offset` the result can be paged; when the limit is reached, `alarmLimitReached: true` is returned.\n- By default only pending alarms are returned (`filter.isPending` default true, `filter.isHistorical` default false).\n\nFilter object:\n\n| Filter member | Type | Description |\n|---|---|---|\n| path | string | Path to filter - partial match |\n| isPending | bool | Send pending alarms - default true |\n| isHistorical | bool | Send historical alarms - default false |\n| state | array of strings | \"occurred\", \"acknowledged\", \"left\", \"leftAcknowledged\" |\n| text | string | Text to filter - partial match |\n| user | string | User entry - partial match |\n| alarmCfgNr | array of numbers | Alarm configuration \"AlarmX\" |\n| priority | array of numbers | |\n| priorityDevice | array of numbers | |\n| alarmGroup | array of numbers | |\n| alarmCollectGroup | array of numbers | |\n| siteGroup | array of numbers | |",
    "requestItem": "AlarmReadRequestItem",
    "responseItem": "AlarmReadResponseItem",
    "examples": [
     {
      "title": "Read alarms for a period",
      "request": {
       "alarmRead": [
        {
         "group": "Alarm",
         "start": "2021-02-28T00:00:00Z",
         "end": "2021-03-02T00:00:00Z"
        }
       ]
      },
      "response": {
       "alarmRead": [
        {
         "group": "Alarm",
         "code": "ok",
         "alarms": [
          {
           "id": "EXMPL1:Room1:AirQuality:GW_LE_Err|1",
           "stamp": "2021-11-03T16:20:48,767+01:00",
           "path": "EXMPL1:Room1:AirQuality:GW_LE_Err",
           "user": "1:web@WebServer:localhost",
           "oldValue": "0",
           "newValue": "1",
           "text": "03.11.21 16:20:48 EXMPL1:Room1:AirQuality:GW_LE_Err Air quality lower limit reached  quit 1:web@WebServer:localhost",
           "siteGroup": 0,
           "group": "Alarm",
           "isPending": true,
           "alarmCfgNr": 1,
           "state": "acknowledged",
           "priority": 2,
           "priorityDevice": 0,
           "alarmGroup": 1,
           "alarmCollectGroup": 0
          },
          {
           "id": "EXMPL1:Room1:AirQuality:FBr_Err|1",
           "stamp": "2021-11-03T16:20:48,717+01:00",
           "path": "EXMPL1:Room1:AirQuality:FBr_Err",
           "user": "1:web@WebServer:localhost",
           "oldValue": "0",
           "newValue": "1",
           "text": "03.11.21 16:20:48 EXMPL1:Room1:AirQuality:FBr_Err Air quality sensor break  quit 1:web@WebServer:localhost",
           "siteGroup": 0,
           "group": "Alarm",
           "isPending": true,
           "alarmCfgNr": 1,
           "state": "acknowledged",
           "priority": 2,
           "priorityDevice": 0,
           "alarmGroup": 1,
           "alarmCollectGroup": 0
          }
         ]
        }
       ]
      }
     },
     {
      "title": "Read historical acknowledged alarms with paging",
      "request": {
       "alarmRead": [
        {
         "group": "Alarm",
         "filter": {
          "isPending": false,
          "isHistorical": true,
          "state": [
           "acknowledged",
           "leftAcknowledged"
          ],
          "path": "EXMPL1:"
         },
         "limit": 100,
         "offset": 0
        }
       ]
      },
      "response": null
     }
    ]
   },
   {
    "transport": [
     "http",
     "ws"
    ],
    "ngOnly": true,
    "basePath": "/json_data",
    "topLevelFields": [
     "whois",
     "user",
     "tag"
    ],
    "eventItem": null,
    "name": "alarmAcknowledge",
    "group": "Alarms",
    "summary": "Acknowledge an alarm.",
    "description": "All alarm functionality is ProMoS NG only. Acknowledges (`set`), un-acknowledges (`reset`) or clears (`clear` = mark current alarm as left) an alarm identified by its unique `id`.\n\nTop-level fields: `whois` (identification of the sender, e.g. \"AlarmViewer\" - mandatory) and `user` (logged-in user name, empty if there is no current user - mandatory).\n\n| level | Meaning |\n|---|---|\n| single | Only this alarm (default) |\n| allForPath | All alarms for the same path - only for current alarms |\n| allForObject | All alarms for the same object - only for current alarms |",
    "requestItem": "AlarmAcknowledgeRequestItem",
    "responseItem": "AlarmAcknowledgeResponseItem",
    "examples": [
     {
      "title": "Acknowledge single alarm",
      "request": {
       "whois": "AlarmViewer",
       "user": "operator",
       "alarmAcknowledge": [
        {
         "id": "EXMPL1:Heating:Valve1:Err|1",
         "action": "set",
         "level": "single"
        }
       ]
      },
      "response": {
       "alarmAcknowledge": [
        {
         "code": "ok",
         "group": "",
         "id": "EXMPL1:Heating:Valve1:Err|1",
         "action": "set"
        }
       ]
      }
     }
    ]
   },
   {
    "transport": [
     "http",
     "ws"
    ],
    "ngOnly": true,
    "basePath": "/json_data",
    "topLevelFields": [
     "whois",
     "tag"
    ],
    "eventItem": null,
    "name": "alarmCount",
    "group": "Alarms",
    "summary": "Get counters of a specific alarm group.",
    "description": "All alarm functionality is ProMoS NG only. Returns the total number of alarms and counters per state for a group (empty group = all groups), time period and filter. The filter object is the same as for `alarmRead`.",
    "requestItem": "AlarmCountRequestItem",
    "responseItem": "AlarmCountResponseItem",
    "examples": [
     {
      "title": "Count alarms",
      "request": {
       "alarmCount": [
        {
         "group": "Alarm",
         "start": "2021-02-28T00:00:00Z",
         "end": "2021-03-02T00:00:00Z"
        }
       ]
      },
      "response": {
       "alarmCount": [
        {
         "code": "ok",
         "group": "Alarm",
         "countTotal": 165,
         "countAlarm": {
          "occurred": 32,
          "left": 100,
          "acknowledged": 20,
          "leftAcknowledged": 13
         }
        }
       ]
      }
     }
    ]
   },
   {
    "transport": [
     "ws"
    ],
    "ngOnly": true,
    "basePath": "/json_data",
    "topLevelFields": [
     "whois",
     "tag"
    ],
    "eventItem": "AlarmEventItem",
    "name": "alarmSubscribe",
    "group": "Alarms",
    "summary": "Monitor alarms (WebSocket only).",
    "description": "All alarm functionality is ProMoS NG only. Subscribes to alarm changes of a group. Only for WebSocket connections.\n\n- The subscription is unique for the given `group`, `tag` and WebSocket connection; a further subscription with the same group and tag overrides the existing one.\n- After loss of the WebSocket connection the client has to re-subscribe.\n- Events are sent as `{\"eventAlarms\": [ ... ]}` with one or more entries; `code` is the trigger (`onCreate`, `onChange`, `onDelete`).",
    "requestItem": "AlarmSubscribeRequestItem",
    "responseItem": "AlarmSubscribeResponseItem",
    "examples": [
     {
      "title": "Subscribe to alarms",
      "request": {
       "alarmSubscribe": [
        {
         "group": "Alarm"
        }
       ]
      },
      "response": {
       "alarmSubscribe": [
        {
         "code": "ok",
         "group": "Alarm"
        }
       ]
      }
     }
    ]
   },
   {
    "transport": [
     "ws"
    ],
    "ngOnly": true,
    "basePath": "/json_data",
    "topLevelFields": [
     "whois",
     "tag"
    ],
    "eventItem": null,
    "name": "alarmUnsubscribe",
    "group": "Alarms",
    "summary": "Unsubscribe monitored alarms (WebSocket only).",
    "description": "All alarm functionality is ProMoS NG only. Removes a subscription created with `alarmSubscribe`. `group` and `tag` must match the subscription.",
    "requestItem": "AlarmUnsubscribeRequestItem",
    "responseItem": "AlarmUnsubscribeResponseItem",
    "examples": [
     {
      "title": "Unsubscribe",
      "request": {
       "alarmUnsubscribe": [
        {
         "group": "Alarm"
        }
       ]
      },
      "response": {
       "alarmUnsubscribe": [
        {
         "code": "ok",
         "group": "Alarm"
        }
       ]
      }
     }
    ]
   },
   {
    "transport": [
     "ws"
    ],
    "ngOnly": true,
    "basePath": "/json_data",
    "topLevelFields": [
     "whois",
     "tag"
    ],
    "eventItem": "AlarmCountEventItem",
    "name": "alarmSubscribeCount",
    "group": "Alarms",
    "summary": "Monitor alarm counters (WebSocket only).",
    "description": "All alarm functionality is ProMoS NG only. Subscribes to alarm counter changes of a group. Only for WebSocket connections.\n\n- The subscription is unique for the given `group`, `tag` and WebSocket connection; a further subscription with the same group and tag overrides the existing one.\n- After loss of the WebSocket connection the client has to re-subscribe.\n- Events are sent as `{\"eventAlarmCount\": [ ... ]}` with one or more entries; `code` is `onChange`.",
    "requestItem": "AlarmSubscribeCountRequestItem",
    "responseItem": "AlarmSubscribeCountResponseItem",
    "examples": [
     {
      "title": "Subscribe to alarm counters",
      "request": {
       "alarmSubscribeCount": [
        {
         "group": "Alarm"
        }
       ]
      },
      "response": {
       "alarmSubscribeCount": [
        {
         "code": "ok",
         "group": "Alarm"
        }
       ]
      }
     }
    ]
   },
   {
    "transport": [
     "ws"
    ],
    "ngOnly": true,
    "basePath": "/json_data",
    "topLevelFields": [
     "whois",
     "tag"
    ],
    "eventItem": null,
    "name": "alarmUnsubscribeCount",
    "group": "Alarms",
    "summary": "Unsubscribe monitored alarm counters (WebSocket only).",
    "description": "All alarm functionality is ProMoS NG only. Removes a subscription created with `alarmSubscribeCount`. `group` and `tag` must match the subscription.",
    "requestItem": "AlarmUnsubscribeCountRequestItem",
    "responseItem": "AlarmUnsubscribeCountResponseItem",
    "examples": [
     {
      "title": "Unsubscribe counters",
      "request": {
       "alarmUnsubscribeCount": [
        {
         "group": "Alarm"
        }
       ]
      },
      "response": {
       "alarmUnsubscribeCount": [
        {
         "code": "ok",
         "group": "Alarm"
        }
       ]
      }
     }
    ]
   },
   {
    "transport": [
     "http",
     "ws"
    ],
    "ngOnly": true,
    "basePath": "/json_data",
    "topLevelFields": [
     "whois",
     "tag"
    ],
    "eventItem": null,
    "name": "version",
    "group": "System",
    "summary": "Get version information and capabilities of the DMS.",
    "description": "Returns application name, version, build date and the server capabilities (supported commands and limitations). Only for ProMoS NG; ProMoS NT returns code \"error\" (\"Unknown command. version\").\n\nThe request array is empty.\n\nCapabilities of ProMoS NT - DMS (2.x): commands `get`, `get-histData`, `set`, `set-histData`, `delete`, `delete-histData`, `rename`, `copy`, `updateBMO`, `changelogGetGroups`, `changelogRead`, `validateUser`, `subscribe`, `unsubscribe`; limitations as for NG except `maxPathLength` = 160.",
    "requestItem": "VersionRequestItem",
    "responseItem": "VersionResponseItem",
    "examples": [
     {
      "title": "ProMoS NG response",
      "request": {
       "version": []
      },
      "response": {
       "version": [
        {
         "code": "ok",
         "app": "DMS",
         "copyright": "Copyright (c) 2022 MST Systemtechnik AG",
         "description": "ProMoS NG Data Management Service",
         "date": "2023-10-02 13:56",
         "appVersion": {
          "full": "2.23.110.206",
          "major": 2,
          "minor": 23,
          "setup": 110,
          "build": 206
         },
         "setupVersion": {
          "full": "2.23.110.24",
          "major": 2,
          "minor": 23,
          "setup": 110,
          "build": 24
         },
         "capabilities": {
          "commands": [
           "version",
           "get",
           "get-histData",
           "get-histData-interpolate",
           "get-query-limit",
           "set",
           "set-histData",
           "delete",
           "delete-histData",
           "rename",
           "copy",
           "updateBMO",
           "verifyPcf",
           "changelogGetGroups",
           "changelogRead",
           "changelogCount",
           "alarmGetGroups",
           "alarmRead",
           "alarmCount",
           "alarmAcknowledge",
           "interpolateGetTemplates",
           "validateUser",
           "subscribe",
           "unsubscribe",
           "changelogSubscribe",
           "changelogUnsubscribe",
           "alarmSubscribe",
           "alarmUnsubscribe",
           "alarmSubscribeCount",
           "alarmUnsubscribeCount",
           "HTTP_import-v1",
           "HTTP_import-v2",
           "HTTP_export-v1",
           "HTTP_export-v2"
          ],
          "limitations": [
           {
            "maxPathLength": 65535,
            "queryMaxDepth": 255,
            "queryMaxResults": 150000,
            "histdataMaxResults": 610000,
            "changelogMaxResults": 100000,
            "websocketMaxReceiveFrameSize": 4194304,
            "websocketMaxReceiveMessageSize": 4194304
           }
          ]
         }
        }
       ]
      }
     },
     {
      "title": "ProMoS NT response",
      "request": {
       "version": []
      },
      "response": {
       "version": [
        {
         "code": "error",
         "message": "Unknown command. version"
        }
       ]
      }
     }
    ]
   },
   {
    "transport": [
     "http",
     "ws"
    ],
    "ngOnly": true,
    "basePath": "/json_data",
    "topLevelFields": [
     "whois",
     "tag"
    ],
    "eventItem": null,
    "name": "interpolateGetTemplates",
    "group": "Interpolation Templates",
    "summary": "Get predefined interpolation parameter templates.",
    "description": "Returns the predefined interpolation parameter templates. Only for ProMoS NG. A template `name` can be used as parameter `interpolateTemplate` when requesting historical data; `interpolateParam`, `filterParams` and `normalizeParams` have the same meaning as in the historical data request.\n\nThe request array is empty.",
    "requestItem": "InterpolateGetTemplatesRequestItem",
    "responseItem": "InterpolateGetTemplatesResponseItem",
    "examples": [
     {
      "title": "Get templates",
      "request": {
       "interpolateGetTemplates": []
      },
      "response": {
       "interpolateGetTemplates": [
        {
         "code": "ok",
         "templates": [
          {
           "name": "RawValues",
           "description": "",
           "dataClasses": [
            "any"
           ],
           "usages": [
            "any",
            "BAI"
           ],
           "interpolateParam": {
            "method": "",
            "interval": 0
           }
          },
          {
           "name": "EnergyCounterUp",
           "description": "",
           "dataClasses": [
            "counterUp"
           ],
           "usages": [
            "any",
            "BAI"
           ],
           "interpolateParam": {
            "method": "diffCtrUpCleaned"
           }
          }
         ]
        }
       ]
      }
     }
    ]
   },
   {
    "transport": [
     "http",
     "ws"
    ],
    "ngOnly": true,
    "basePath": "/json_data",
    "topLevelFields": [
     "whois",
     "tag"
    ],
    "eventItem": null,
    "name": "nodeReferences",
    "group": "Node References",
    "summary": "Get predefined node references.",
    "description": "Returns the predefined node references (reference ids used e.g. in the data point `refs` and in the export parameter `hasRefs`). Only for ProMoS NG.\n\nThe request array is either empty (all references) or an array of numbers with the reference ids to return.",
    "requestItem": "NodeRefRequestItem",
    "responseItem": "NodeRefResponseItem",
    "examples": [
     {
      "title": "Get all node references",
      "request": {
       "nodeReferences": []
      },
      "response": {
       "nodeReferences": [
        {
         "code": "ok",
         "references": [
          {
           "id": 0,
           "name": "DeviceSetpoint",
           "description": "Setpoint value on Device"
          },
          {
           "id": 1,
           "name": "DeviceInput",
           "description": "Only input value on decice"
          },
          {
           "id": 2,
           "name": "DeviceDigital",
           "description": "Digital value on device"
          }
         ]
        }
       ]
      }
     },
     {
      "title": "Get filtered node references",
      "request": {
       "nodeReferences": [
        0,
        2
       ]
      },
      "response": null
     }
    ]
   },
   {
    "transport": [
     "http"
    ],
    "ngOnly": false,
    "basePath": "/json_auth",
    "topLevelFields": [],
    "eventItem": null,
    "name": "validateUser",
    "group": "Authentication",
    "summary": "Validate local ProMoS user(s).",
    "description": "Validates one or more local ProMoS users by login name and password. The base path for the Authentication API is **/json_auth** (not /json_data).\n\n- `password` can be plain text or MD5 hashed.\n- Result codes: `ok`, `invalid credentials` (loginName / password not valid), `error` (fatal error, e.g. invalid JSON).\n- `tag` is defined per array item.\n- The user fields (userName, comment, ...) are returned nested in `userData`.",
    "requestItem": "AuthValidateUserRequestItem",
    "responseItem": "AuthValidateUserResponseItem",
    "examples": [
     {
      "title": "Validate a user",
      "request": {
       "validateUser": [
        {
         "loginName": "test",
         "password": "<password>"
        }
       ]
      },
      "response": {
       "validateUser": [
        {
         "loginName": "test",
         "userData": {
          "userName": "test",
          "comment": "This is a test user",
          "language": "ger",
          "host": "",
          "startImage": "Main",
          "isAdmin": true,
          "isUserAdmin": false,
          "hasAutoLogin": false,
          "hasAutoLogoff": false,
          "allowedWebAccess": true,
          "accessLevels": [
           1,
           2,
           3,
           4,
           8,
           15,
           16
          ],
          "stationLevels": [
           1,
           2,
           3,
           8
          ]
         }
        }
       ]
      }
     },
     {
      "title": "Fatal error",
      "request": null,
      "response": {
       "validateUser": [
        {
         "code": "error",
         "message": "Expected JSON encoded data, but got something else."
        }
       ]
      }
     }
    ]
   }
  ],
  "httpEndpoints": [
   {
    "method": "put",
    "path": "/import/v1",
    "group": "Import / Export",
    "summary": "Import data points (v1 format).",
    "description": "Only for ProMoS NG. Imports data points sent in the request body (HTTP(S) PUT). Any existing data point is overwritten with the new values. Lines without error are imported; lines with errors are reported in the `errors` array of the JSON response.\n\nFormats:\n\n- **v1**: traditional ProMoS NT storage format, always ISO 8859-1 (Latin1) encoded CSV without header; fields `path;type;value;readwriteFlag`. Restriction: time stamp and state are not present.\n- **v2**: JSON Lines (https://jsonlines.org/), always UTF-8; one object per line with `path`, `type`, `value`, `stamp`, `state` (see schema ExportDataPointV2Line).\n\nIn case of a fatal error any HTTP status code (like 400, 404, 405...) is returned.",
    "parameters": [
     {
      "name": "path",
      "in": "query",
      "required": false,
      "description": "The start path for the import. Default: empty (root path).",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "onlyChilds",
      "in": "query",
      "required": false,
      "description": "If true, the largest common part of the paths being imported is excluded from the import. Default: false.",
      "schema": {
       "type": "boolean",
       "default": false
      }
     }
    ],
    "requestBody": {
     "contentType": "text/csv; charset=ISO-8859-1",
     "description": "Data points in v1 format.",
     "schemaRef": null,
     "example": "EXMPL1:Room1:Temp:GW_Lo:PLC:Station;DWS;1;RW\nEXMPL1:Room1:Temp:GW_Lo:PLC:Telegram;DWS;101;RW\n"
    },
    "responses": {
     "200": {
      "contentType": "application/json",
      "description": "Import result (schema ImportDataPointsResult).",
      "example": {
       "beforeImport": {
        "nodes": 196544,
        "pcf": 23958
       },
       "afterImport": {
        "nodes": 196553,
        "pcf": 23958
       },
       "errors": [
        "Parse error at offset 1: 'Missing a name for object member.' on line 4 ({xxyy\"path\":\"EXMPL1:E0\",\"type\":\"bool\",\"value\":false,\"stamp\":\"2021-06-10T11:43:51,757+02:00\",\"state\":\"ok\"})"
       ]
      }
     }
    }
   },
   {
    "method": "put",
    "path": "/import/v2",
    "group": "Import / Export",
    "summary": "Import data points (v2 format).",
    "description": "Only for ProMoS NG. Imports data points sent in the request body (HTTP(S) PUT). Any existing data point is overwritten with the new values. Lines without error are imported; lines with errors are reported in the `errors` array of the JSON response.\n\nFormats:\n\n- **v1**: traditional ProMoS NT storage format, always ISO 8859-1 (Latin1) encoded CSV without header; fields `path;type;value;readwriteFlag`. Restriction: time stamp and state are not present.\n- **v2**: JSON Lines (https://jsonlines.org/), always UTF-8; one object per line with `path`, `type`, `value`, `stamp`, `state` (see schema ExportDataPointV2Line).\n\nIn case of a fatal error any HTTP status code (like 400, 404, 405...) is returned.",
    "parameters": [
     {
      "name": "path",
      "in": "query",
      "required": false,
      "description": "The start path for the import. Default: empty (root path).",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "onlyChilds",
      "in": "query",
      "required": false,
      "description": "If true, the largest common part of the paths being imported is excluded from the import. Default: false.",
      "schema": {
       "type": "boolean",
       "default": false
      }
     }
    ],
    "requestBody": {
     "contentType": "application/jsonl; charset=utf-8",
     "description": "Data points in v2 format.",
     "schemaRef": "ExportDataPointV2Line",
     "example": "{\"path\":\"EXMPL1:Room1:Temp:GW_Lo:PLC:Station\",\"type\":\"int\",\"value\":1,\"stamp\":\"2021-06-10T13:34:17,679+02:00\",\"state\":\"ok\"}\n{\"path\":\"EXMPL1:Room1:Temp:GW_Lo:PLC:Telegram\",\"type\":\"int\",\"value\":101,\"stamp\":\"2021-06-10T13:34:17,679+02:00\",\"state\":\"ok\"}\n"
    },
    "responses": {
     "200": {
      "contentType": "application/json",
      "description": "Import result (schema ImportDataPointsResult).",
      "example": {
       "beforeImport": {
        "nodes": 196544,
        "pcf": 23958
       },
       "afterImport": {
        "nodes": 196553,
        "pcf": 23958
       },
       "errors": [
        "Parse error at offset 1: 'Missing a name for object member.' on line 4 ({xxyy\"path\":\"EXMPL1:E0\",\"type\":\"bool\",\"value\":false,\"stamp\":\"2021-06-10T11:43:51,757+02:00\",\"state\":\"ok\"})"
       ]
      }
     }
    }
   },
   {
    "method": "get",
    "path": "/export/v1",
    "group": "Import / Export",
    "summary": "Export data points (v1 format).",
    "description": "Only for ProMoS NG. Exports data points as a file (HTTP(S) GET).\n\nFormats:\n\n- **v1**: traditional ProMoS NT storage format, always ISO 8859-1 (Latin1) encoded CSV without header; fields `path;type;value;readwriteFlag`. Restriction: time stamp and state are not present.\n- **v2**: JSON Lines (https://jsonlines.org/), always UTF-8; one object per line with `path`, `type`, `value`, `stamp`, `state` (see schema ExportDataPointV2Line).\n\nTo get the same content as stored by ProMoS DMS:\n\n| File | Request |\n|---|---|\n| ProMoS.dms | `/export/v1?excludeStartPath=BMO%3A` |\n| BMO.dms | `/export/v1?path=BMO&pathPrefix=BMO` |\n\nIn case of a fatal error any HTTP status code (like 400, 404, 405...) is returned. On a valid request HTTP 200 with the file is returned.",
    "parameters": [
     {
      "name": "path",
      "in": "query",
      "required": false,
      "description": "The start path for the export. Default: empty (root path).",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "excludeStartPath",
      "in": "query",
      "required": false,
      "description": "Any path starting with this value is not exported.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "pathPrefix",
      "in": "query",
      "required": false,
      "description": "Any exported RDS will have this value as prefix RDS part.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "includeReadonly",
      "in": "query",
      "required": false,
      "description": "\"true\", \"t\" or \"1\" will also export read-only data points (mostly used internally by the system). Default: 0.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "hasRefs",
      "in": "query",
      "required": false,
      "description": "Reference id(s) to export, multiple ids separated by \",\". For reference ids see the nodeReferences command.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "filename",
      "in": "query",
      "required": false,
      "description": "The file name to be used in the response. Default: \"export.csv\".",
      "schema": {
       "type": "string",
       "default": "export.csv"
      }
     },
     {
      "name": "onlyChilds",
      "in": "query",
      "required": false,
      "description": "If true, only child data points of the data point being exported are included. Default: false.",
      "schema": {
       "type": "boolean",
       "default": false
      }
     }
    ],
    "requestBody": null,
    "responses": {
     "200": {
      "contentType": "text/csv; charset=ISO-8859-1",
      "description": "Exported data point file.",
      "example": "EXMPL1:Room1:Temp:GW_Lo:PLC:Station;DWS;1;RW\nEXMPL1:Room1:Temp:GW_Lo:PLC:Telegram;DWS;101;RW\n"
     }
    }
   },
   {
    "method": "get",
    "path": "/export/v2",
    "group": "Import / Export",
    "summary": "Export data points (v2 format).",
    "description": "Only for ProMoS NG. Exports data points as a file (HTTP(S) GET).\n\nFormats:\n\n- **v1**: traditional ProMoS NT storage format, always ISO 8859-1 (Latin1) encoded CSV without header; fields `path;type;value;readwriteFlag`. Restriction: time stamp and state are not present.\n- **v2**: JSON Lines (https://jsonlines.org/), always UTF-8; one object per line with `path`, `type`, `value`, `stamp`, `state` (see schema ExportDataPointV2Line).\n\nIn case of a fatal error any HTTP status code (like 400, 404, 405...) is returned. On a valid request HTTP 200 with the file is returned.",
    "parameters": [
     {
      "name": "path",
      "in": "query",
      "required": false,
      "description": "The start path for the export. Default: empty (root path).",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "excludeStartPath",
      "in": "query",
      "required": false,
      "description": "Any path starting with this value is not exported.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "pathPrefix",
      "in": "query",
      "required": false,
      "description": "Any exported RDS will have this value as prefix RDS part.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "includeReadonly",
      "in": "query",
      "required": false,
      "description": "\"true\", \"t\" or \"1\" will also export read-only data points (mostly used internally by the system). Default: 0.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "hasRefs",
      "in": "query",
      "required": false,
      "description": "Reference id(s) to export, multiple ids separated by \",\". For reference ids see the nodeReferences command.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "filename",
      "in": "query",
      "required": false,
      "description": "The file name to be used in the response. Default: \"export.jsonl\".",
      "schema": {
       "type": "string",
       "default": "export.jsonl"
      }
     },
     {
      "name": "onlyChilds",
      "in": "query",
      "required": false,
      "description": "If true, only child data points of the data point being exported are included. Default: false.",
      "schema": {
       "type": "boolean",
       "default": false
      }
     }
    ],
    "requestBody": null,
    "responses": {
     "200": {
      "contentType": "application/jsonl; charset=utf-8",
      "description": "Exported data point file.",
      "example": "{\"path\":\"EXMPL1:Room1:Temp:GW_Lo:PLC:Station\",\"type\":\"int\",\"value\":1,\"stamp\":\"2021-06-10T13:34:17,679+02:00\",\"state\":\"ok\"}\n{\"path\":\"EXMPL1:Room1:Temp:GW_Lo:PLC:Telegram\",\"type\":\"int\",\"value\":101,\"stamp\":\"2021-06-10T13:34:17,679+02:00\",\"state\":\"ok\"}\n"
     }
    }
   },
   {
    "method": "put",
    "path": "/historical_data_import/v1",
    "group": "Import / Export",
    "summary": "Import historical data (CSV).",
    "description": "Only for ProMoS NG. Imports historical values sent as CSV in the request body (HTTP(S) PUT).\n\nMandatory: either the URL parameter `path`, or `columns` containing a `path` column that holds the data point path of each line.\n\nLines without error are imported; lines with errors are reported in `errors`. The import is aborted after a maximum of 100 errors.\n\n`timestampFormat` placeholders: see the table of the historical data export.\n\nIn case of a fatal error any HTTP status code (like 400, 404, 405...) is returned.",
    "parameters": [
     {
      "name": "path",
      "in": "query",
      "required": false,
      "description": "The path of the value data point (mandatory unless `columns` contains `path`).",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "createPath",
      "in": "query",
      "required": false,
      "description": "Create path when not existing: 0 = no, 1 = yes, only value path (last value of the import will be set), 2 = yes, additionally an inactive \"TRD\" configuration is set. Default: 2.",
      "schema": {
       "type": "integer",
       "enum": [
        0,
        1,
        2
       ],
       "default": 2
      }
     },
     {
      "name": "removeBeforeImport",
      "in": "query",
      "required": false,
      "description": "Remove existing data for the path(s): 0 = no, 1 = range (same as in import), 2 = all. Default: 0.",
      "schema": {
       "type": "integer",
       "enum": [
        0,
        1,
        2
       ],
       "default": 0
      }
     },
     {
      "name": "encoding",
      "in": "query",
      "required": false,
      "description": "Text encoding (UTF-8 or ISO-8859-1). Default: UTF-8.",
      "schema": {
       "type": "string",
       "enum": [
        "UTF-8",
        "ISO-8859-1"
       ],
       "default": "UTF-8"
      }
     },
     {
      "name": "fieldDelimiter",
      "in": "query",
      "required": false,
      "description": "Delimiter between CSV fields. Default: \";\".",
      "schema": {
       "type": "string",
       "default": ";"
      }
     },
     {
      "name": "textQualifier",
      "in": "query",
      "required": false,
      "description": "Marks where text is enclosed. Default: '\"'.",
      "schema": {
       "type": "string",
       "default": "\""
      }
     },
     {
      "name": "headerLines",
      "in": "query",
      "required": false,
      "description": "Count of header lines that will be ignored. Default: 0.",
      "schema": {
       "type": "integer",
       "default": 0
      }
     },
     {
      "name": "columns",
      "in": "query",
      "required": false,
      "description": "Column designations in the correct order, separated by ';'. Possible designations: timestamp, value, status, path. Default: \"timestamp;value\".",
      "schema": {
       "type": "string",
       "default": "timestamp;value"
      }
     },
     {
      "name": "timestampFormat",
      "in": "query",
      "required": false,
      "description": "X (Unix seconds), x (Unix milliseconds), ISODate, ISODateWithMs, RFC2822Date, TextDate or other textual formats with placeholders. Can be left empty so several formats are tested on the first time stamp (not recommended, not all formats are unambiguous). Default: X.",
      "schema": {
       "type": "string",
       "default": "X"
      }
     },
     {
      "name": "filterTimestampMin",
      "in": "query",
      "required": false,
      "description": "Filter out values earlier than the given value (ms since 1970-01-01). Can be used to reduce unwanted data from the past. Default: 1.",
      "schema": {
       "type": "integer",
       "default": 1
      }
     },
     {
      "name": "timeZone",
      "in": "query",
      "required": false,
      "description": "UTC, LocalTime or any valid TZ identifier, e.g. Europe/Zurich. Default: UTC.",
      "schema": {
       "type": "string",
       "default": "UTC"
      }
     },
     {
      "name": "factor",
      "in": "query",
      "required": false,
      "description": "Factor applied to imported values. Default: 1.",
      "schema": {
       "type": "number",
       "default": 1
      }
     },
     {
      "name": "statusMap",
      "in": "query",
      "required": false,
      "description": "Map to convert incoming status (when present). Target states: ok, startup, comErr, inv; \"Other\" maps all other values. Default: \"ok=ok;startup=startup;comErr=comErr;inv=inv;Other=inv\".",
      "schema": {
       "type": "string",
       "default": "ok=ok;startup=startup;comErr=comErr;inv=inv;Other=inv"
      }
     }
    ],
    "requestBody": {
     "contentType": "text/csv",
     "description": "CSV data with the columns defined by `columns`.",
     "schemaRef": null,
     "example": "1651242600;0.498\n1651243500;0.512\n"
    },
    "responses": {
     "200": {
      "contentType": "application/json",
      "description": "Import result (schema ImportHistDataResult).",
      "example": {
       "imported": 367294,
       "errors": []
      }
     }
    }
   },
   {
    "method": "get",
    "path": "/historical_data_export/v1",
    "group": "Import / Export",
    "summary": "Export historical data of a data point (CSV).",
    "description": "Only for ProMoS NG. Exports historical data of one data point as a CSV file (HTTP(S) GET). The parameters `start`, `end`, `interpolateTemplate`, `interpolateMethod`, `interval`, `alignStartEndTimestamp` and `prospective` have the same meaning as in the historical data request (get-histData).\n\nTime stamp output formats (`timestampFormat`):\n\n| Expression | Output |\n|---|---|\n| d | Day without leading zero (1-31) |\n| dd | Day with leading zero (01-31) |\n| ddd | Abbreviated day name ('Mon'-'Sun') |\n| dddd | Long day name ('Monday'-'Sunday') |\n| M | Month without leading zero (1-12) |\n| MM | Month with leading zero (01-12) |\n| MMM | Abbreviated month name ('Jan'-'Dec') |\n| MMMM | Long month name ('January'-'December') |\n| yy | Two digit year (00-99) |\n| yyyy | Four digit year (negative years get a minus sign) |\n| h | Hour without leading zero (0-23 or 1-12 with AM/PM) |\n| hh | Hour with leading zero (00-23 or 01-12 with AM/PM) |\n| H | Hour without leading zero (0-23, even with AM/PM) |\n| HH | Hour with leading zero (00-23, even with AM/PM) |\n| m | Minute without leading zero (0-59) |\n| mm | Minute with leading zero (00-59) |\n| s | Second without leading zero (0-59) |\n| ss | Second with leading zero (00-59) |\n| z or zz | Fractional second without trailing zeroes |\n| zzz | Fractional second, millisecond precision (000-999) |\n| AP or A | AM/PM display |\n| ap or a | am/pm display |\n| t | Time zone abbreviation (e.g. \"CEST\"; not unique) |\n| tt | UTC offset without colon (e.g. \"+0200\") |\n| ttt | UTC offset with colon (e.g. \"+02:00\") |\n| tttt | Time zone name (e.g. \"Europe/Berlin\") |\n| X | Unix time stamp in seconds since 1970-01-01 UTC |\n| x | Unix time stamp in milliseconds since 1970-01-01 UTC |\n\nIn case of a fatal error any HTTP status code (like 400, 404, 405...) is returned. On a valid request HTTP 200 with the file is returned.",
    "parameters": [
     {
      "name": "path",
      "in": "query",
      "required": true,
      "description": "Path of the data point to export (required).",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "start",
      "in": "query",
      "required": false,
      "description": "Start time stamp, as in the historical data request. Default: first.",
      "schema": {
       "type": "string",
       "default": "first"
      }
     },
     {
      "name": "end",
      "in": "query",
      "required": false,
      "description": "End time stamp, as in the historical data request. Default: last.",
      "schema": {
       "type": "string",
       "default": "last"
      }
     },
     {
      "name": "interpolateTemplate",
      "in": "query",
      "required": false,
      "description": "Interpolation template name (see interpolateGetTemplates).",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "interpolateMethod",
      "in": "query",
      "required": false,
      "description": "Interpolation method, as in the historical data request. Default: prevNextLinearFill.",
      "schema": {
       "type": "string",
       "default": "prevNextLinearFill"
      }
     },
     {
      "name": "interval",
      "in": "query",
      "required": false,
      "description": "Interpolation interval in seconds, as in the historical data request. Default: 900.",
      "schema": {
       "type": "integer",
       "default": 900
      }
     },
     {
      "name": "alignStartEndTimestamp",
      "in": "query",
      "required": false,
      "description": "As in the historical data request. Default: 0.",
      "schema": {
       "type": "integer",
       "default": 0
      }
     },
     {
      "name": "prospective",
      "in": "query",
      "required": false,
      "description": "As in the historical data request. Default: 0.",
      "schema": {
       "type": "integer",
       "default": 0
      }
     },
     {
      "name": "addState",
      "in": "query",
      "required": false,
      "description": "1 adds a state column (and \"State\" in the default header). Values: \"ok\", \"startup\", \"comErr\" or \"inv\". Default: 0.",
      "schema": {
       "type": "integer",
       "enum": [
        0,
        1
       ],
       "default": 0
      }
     },
     {
      "name": "addStorageReason",
      "in": "query",
      "required": false,
      "description": "1 adds a storage reason column (and \"StorageReason\" in the default header). Values: empty, \"cycle\", \"change\", \"diff\" or \"unknown\". Default: 0.",
      "schema": {
       "type": "integer",
       "enum": [
        0,
        1
       ],
       "default": 0
      }
     },
     {
      "name": "headerLine",
      "in": "query",
      "required": false,
      "description": "Custom header line. Default: Timestamp;Value.",
      "schema": {
       "type": "string",
       "default": "Timestamp;Value"
      }
     },
     {
      "name": "fieldDelimiter",
      "in": "query",
      "required": false,
      "description": "Delimiter for CSV fields. Default: \";\".",
      "schema": {
       "type": "string",
       "default": ";"
      }
     },
     {
      "name": "textQualifier",
      "in": "query",
      "required": false,
      "description": "Text qualifier. Default: '\"'.",
      "schema": {
       "type": "string",
       "default": "\""
      }
     },
     {
      "name": "endOfLine",
      "in": "query",
      "required": false,
      "description": "End of line character(s). Default: \\r\\n (CR/LF).",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "timeZone",
      "in": "query",
      "required": false,
      "description": "UTC, LocalTime or any valid TZ identifier, e.g. Europe/Zurich. Default: UTC.",
      "schema": {
       "type": "string",
       "default": "UTC"
      }
     },
     {
      "name": "timestampFormat",
      "in": "query",
      "required": false,
      "description": "Time stamp output format (see table in the description). Default: yyyy-MM-ddTHH:mm:ss.zzzttt (ISO 8601).",
      "schema": {
       "type": "string",
       "default": "yyyy-MM-ddTHH:mm:ss.zzzttt"
      }
     },
     {
      "name": "decimalPoint",
      "in": "query",
      "required": false,
      "description": "Decimal point for values (e.g. . or ,). Default: \".\".",
      "schema": {
       "type": "string",
       "default": "."
      }
     },
     {
      "name": "decimals",
      "in": "query",
      "required": false,
      "description": "Number of decimals for the values. Default: 3.",
      "schema": {
       "type": "integer",
       "default": 3
      }
     },
     {
      "name": "encoding",
      "in": "query",
      "required": false,
      "description": "Data encoding, UTF-8 or ISO-8859-1. Default: UTF-8.",
      "schema": {
       "type": "string",
       "enum": [
        "UTF-8",
        "ISO-8859-1"
       ],
       "default": "UTF-8"
      }
     },
     {
      "name": "filename",
      "in": "query",
      "required": false,
      "description": "File name for the exported data. Default: DataExport_{path}_{yyyyMMddHHmmss}.csv.",
      "schema": {
       "type": "string"
      }
     }
    ],
    "requestBody": null,
    "responses": {
     "200": {
      "contentType": "text/csv",
      "description": "CSV file. Example request: `/historical_data_export/v1?path=EXMPL1%3AMeter1%3ACurrent%20I%20L1`.",
      "example": "\"Timestamp\";\"Value\"\n2022-04-29T14:30:00.000+00:00;0.498\n2022-04-29T14:45:00.000+00:00;0.512\n2022-04-29T15:00:00.000+00:00;0.670\n"
     }
    }
   },
   {
    "method": "get",
    "path": "/changelog_export/v1",
    "group": "Import / Export",
    "summary": "Export change logs (CSV).",
    "description": "Only for ProMoS NG. Exports change log entries as a CSV file (HTTP(S) GET). `start`/`end` as in the historical data request. Time stamp format placeholders: see the table of `/historical_data_export/v1`.\n\nResponse columns:\n\n| Column | Description |\n|---|---|\n| Timestamp | Formatted by URL parameter \"timestampFormat\" |\n| Path | DMS RDS |\n| User | User identity when present |\n| OldValue | |\n| NewValue | |\n| Text | Formatted by URL parameter \"format\" |\n| SiteGroup | |\n| Group | Change log group like \"Manip1\" |\n\nNote: the Text column refers to a URL parameter \"format\" which is not listed in this endpoint's parameter table (it is listed for the alarm export).\n\nIn case of a fatal error any HTTP status code (like 400, 404, 405...) is returned. On a valid request HTTP 200 with the file is returned.",
    "parameters": [
     {
      "name": "start",
      "in": "query",
      "required": false,
      "description": "Start time stamp. Default: first.",
      "schema": {
       "type": "string",
       "default": "first"
      }
     },
     {
      "name": "end",
      "in": "query",
      "required": false,
      "description": "End time stamp. Default: last.",
      "schema": {
       "type": "string",
       "default": "last"
      }
     },
     {
      "name": "filter_path",
      "in": "query",
      "required": false,
      "description": "Path to filter - partial match.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "filter_exactPath",
      "in": "query",
      "required": false,
      "description": "Path to filter - exact match.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "filter_text",
      "in": "query",
      "required": false,
      "description": "Text to filter - partial match.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "filter_user",
      "in": "query",
      "required": false,
      "description": "User entry - partial match.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "filter_siteGroup",
      "in": "query",
      "required": false,
      "description": "One or more site group numbers, separated by \",\".",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "filter_group",
      "in": "query",
      "required": false,
      "description": "Group name of the change log to export - see changelogGetGroups.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "fieldDelimiter",
      "in": "query",
      "required": false,
      "description": "Delimiter for CSV fields. Default: \";\".",
      "schema": {
       "type": "string",
       "default": ";"
      }
     },
     {
      "name": "textQualifier",
      "in": "query",
      "required": false,
      "description": "Text qualifier. Default: '\"'.",
      "schema": {
       "type": "string",
       "default": "\""
      }
     },
     {
      "name": "endOfLine",
      "in": "query",
      "required": false,
      "description": "End of line character(s). Default: \\r\\n (CR/LF).",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "timeZone",
      "in": "query",
      "required": false,
      "description": "UTC, LocalTime or any valid TZ identifier, e.g. Europe/Zurich. Default: UTC.",
      "schema": {
       "type": "string",
       "default": "UTC"
      }
     },
     {
      "name": "timestampFormat",
      "in": "query",
      "required": false,
      "description": "Time stamp output format (see table in the description). Default: yyyy-MM-ddTHH:mm:ss.zzzttt (ISO 8601).",
      "schema": {
       "type": "string",
       "default": "yyyy-MM-ddTHH:mm:ss.zzzttt"
      }
     },
     {
      "name": "decimalPoint",
      "in": "query",
      "required": false,
      "description": "Decimal point for values (e.g. . or ,). Default: \".\".",
      "schema": {
       "type": "string",
       "default": "."
      }
     },
     {
      "name": "decimals",
      "in": "query",
      "required": false,
      "description": "Number of decimals for the values. Default: 3.",
      "schema": {
       "type": "integer",
       "default": 3
      }
     },
     {
      "name": "encoding",
      "in": "query",
      "required": false,
      "description": "Data encoding, UTF-8 or ISO-8859-1. Default: UTF-8.",
      "schema": {
       "type": "string",
       "enum": [
        "UTF-8",
        "ISO-8859-1"
       ],
       "default": "UTF-8"
      }
     },
     {
      "name": "filename",
      "in": "query",
      "required": false,
      "description": "File name for the exported data. Default: ChangelogExport_{yyyyMMddHHmmss}.csv.",
      "schema": {
       "type": "string"
      }
     }
    ],
    "requestBody": null,
    "responses": {
     "200": {
      "contentType": "text/csv",
      "description": "CSV file with the change log entries.",
      "example": "\"Timestamp\";\"Path\";\"User\";\"OldValue\";\"NewValue\";\"Text\";\"SiteGroup\";\"Group\"\n\"2023-09-06T06:47:47.369+00:00\";\"EXMPL1:MBus:Bus005:ComBus:Enabled\";\"operator\";\"0\";\"1\";\"MBus Bus005 / On\";0;\"Manip1\"\n"
     }
    }
   },
   {
    "method": "get",
    "path": "/alarm_export/v1",
    "group": "Import / Export",
    "summary": "Export alarms (CSV).",
    "description": "Only for ProMoS NG. Exports alarms as a CSV file (HTTP(S) GET). `start`/`end` as in the historical data request. Time stamp format placeholders: see the table of `/historical_data_export/v1`.\n\nResponse columns:\n\n| Column | Description |\n|---|---|\n| Timestamp | Formatted by URL parameter \"timestampFormat\" |\n| Path | DMS RDS |\n| User | User identity for acknowledged alarm |\n| OldValue | |\n| NewValue | |\n| Text | Formatted by URL parameter \"format\" |\n| SiteGroup | |\n| Group | Typically \"Alarm\" or \"Service\" |\n| IsPending | 0 or 1, 1 for pending alarm |\n| AlarmCfgNr | Integer, alarm configuration \"Alarmx\" |\n| State | \"unknown\", \"occurred\", \"acknowledged\", \"left\", \"leftAcknowledged\" |\n| Priority | |\n| PriorityDevice | |\n| AlarmGroup | |\n| AlarmCollectGroup | |\n\nIn case of a fatal error any HTTP status code (like 400, 404, 405...) is returned. On a valid request HTTP 200 with the file is returned.",
    "parameters": [
     {
      "name": "start",
      "in": "query",
      "required": false,
      "description": "Start time stamp. Default: first.",
      "schema": {
       "type": "string",
       "default": "first"
      }
     },
     {
      "name": "end",
      "in": "query",
      "required": false,
      "description": "End time stamp. Default: last.",
      "schema": {
       "type": "string",
       "default": "last"
      }
     },
     {
      "name": "filter_isPending",
      "in": "query",
      "required": false,
      "description": "0 (false) or 1 (true): send pending alarms - default is true.",
      "schema": {
       "type": "integer",
       "enum": [
        0,
        1
       ]
      }
     },
     {
      "name": "filter_isHistorical",
      "in": "query",
      "required": false,
      "description": "0 (false) or 1 (true): send historical alarms - default is false.",
      "schema": {
       "type": "integer",
       "enum": [
        0,
        1
       ]
      }
     },
     {
      "name": "filter_group",
      "in": "query",
      "required": false,
      "description": "Group name of the alarms to export - see alarmGetGroups.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "filter_path",
      "in": "query",
      "required": false,
      "description": "Path to filter - partial match.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "filter_exactPath",
      "in": "query",
      "required": false,
      "description": "Path to filter - exact match.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "filter_state",
      "in": "query",
      "required": false,
      "description": "One or more states separated by \",\": \"occurred\", \"acknowledged\", \"left\", \"leftAcknowledged\".",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "filter_text",
      "in": "query",
      "required": false,
      "description": "Text to filter - partial match.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "filter_user",
      "in": "query",
      "required": false,
      "description": "User entry - partial match.",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "filter_alarmCfgNr",
      "in": "query",
      "required": false,
      "description": "One or more alarm configuration numbers (\"AlarmX\"), separated by \",\".",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "filter_priority",
      "in": "query",
      "required": false,
      "description": "One or more priorities, separated by \",\".",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "filter_alarmGroup",
      "in": "query",
      "required": false,
      "description": "One or more alarm groups (numbers), separated by \",\".",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "filter_alarmCollectGroup",
      "in": "query",
      "required": false,
      "description": "One or more alarm collective groups, separated by \",\".",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "filter_siteGroup",
      "in": "query",
      "required": false,
      "description": "One or more site groups, separated by \",\".",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "format",
      "in": "query",
      "required": false,
      "description": "Other format for the \"Text\" column than default - see ProMoS documentation, formats like \"#c / #N / #V^NAME / #z(Ein:Aus) / #u\".",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "locale",
      "in": "query",
      "required": false,
      "description": "Locale in the format \"{language lowercase, ISO 639}_{country, ISO 3166}\", e.g. \"de_CH\".",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "fieldDelimiter",
      "in": "query",
      "required": false,
      "description": "Delimiter for CSV fields. Default: \";\".",
      "schema": {
       "type": "string",
       "default": ";"
      }
     },
     {
      "name": "textQualifier",
      "in": "query",
      "required": false,
      "description": "Text qualifier. Default: '\"'.",
      "schema": {
       "type": "string",
       "default": "\""
      }
     },
     {
      "name": "endOfLine",
      "in": "query",
      "required": false,
      "description": "End of line character(s). Default: \\r\\n (CR/LF).",
      "schema": {
       "type": "string"
      }
     },
     {
      "name": "timeZone",
      "in": "query",
      "required": false,
      "description": "UTC, LocalTime or any valid TZ identifier, e.g. Europe/Zurich. Default: UTC.",
      "schema": {
       "type": "string",
       "default": "UTC"
      }
     },
     {
      "name": "timestampFormat",
      "in": "query",
      "required": false,
      "description": "Time stamp output format (see table in the description). Default: yyyy-MM-ddTHH:mm:ss.zzzttt (ISO 8601).",
      "schema": {
       "type": "string",
       "default": "yyyy-MM-ddTHH:mm:ss.zzzttt"
      }
     },
     {
      "name": "decimalPoint",
      "in": "query",
      "required": false,
      "description": "Decimal point for values (e.g. . or ,). Default: \".\".",
      "schema": {
       "type": "string",
       "default": "."
      }
     },
     {
      "name": "decimals",
      "in": "query",
      "required": false,
      "description": "Number of decimals for the values. Default: 3.",
      "schema": {
       "type": "integer",
       "default": 3
      }
     },
     {
      "name": "encoding",
      "in": "query",
      "required": false,
      "description": "Data encoding, UTF-8 or ISO-8859-1. Default: UTF-8.",
      "schema": {
       "type": "string",
       "enum": [
        "UTF-8",
        "ISO-8859-1"
       ],
       "default": "UTF-8"
      }
     },
     {
      "name": "filename",
      "in": "query",
      "required": false,
      "description": "File name for the exported data. Default: AlarmExport_{yyyyMMddHHmmss}.csv.",
      "schema": {
       "type": "string"
      }
     }
    ],
    "requestBody": null,
    "responses": {
     "200": {
      "contentType": "text/csv",
      "description": "CSV file with the alarms.",
      "example": "\"Timestamp\";\"Path\";\"User\";\"OldValue\";\"NewValue\";\"Text\";\"SiteGroup\";\"Group\";\"IsPending\";\"AlarmCfgNr\";\"State\";\"Priority\";\"PriorityDevice\";\"AlarmGroup\";\"AlarmCollectGroup\"\n\"2024-05-30T15:27:23.228+00:00\";\"EXMPL1:MBus:001:ComDev:ErrCom\";\"\";\"0\";\"1\";\"MBus Bus001, Adr001 communication error\";0;\"Alarm\";1;1;\"occurred\";2;0;998;0\n"
     }
    }
   }
  ]
 }
}