Sign in

v70

latestOpenAPI 3.0.0EUPLraw.githubusercontent.com2026-08-031426201.0 MB
South Connectors

Test south connector item

Test a south connector item

post/api/south/{southId}/items/test

Path parameters

southIdstring required

Query parameters

southType'opcua' | 'mqtt' | 'modbus' | 'oianalytics' | 'ads' | 'folder-scanner' | 'ftp' | 'influxdb' | 'mssql' | 'mysql' | 'odbc' | 'oledb' | 'opc' | 'oracle' | 'osisoft-pi' | 'postgresql' | 'rest' | 'sftp' | 'sqlite' required

Type representing the possible types for a South connector.

itemNamestring required

Request body

Example request

{
  "itemSettings": {
    "dateTimeFields": [
      {
        "timezone": "Europe/Paris"
      }
    ],
    "serialization": {
      "outputTimezone": "Europe/Paris"
    }
  }
}

Response

Raw and (optionally) transformed test results

connectionDurationnumber double required
queryDurationnumber double required

Example response

{
  "raw": {
    "type": "time-values",
    "content": [
      {
        "pointId": "point1",
        "timestamp": "2023-10-31T12:34:56.789Z"
      }
    ]
  },
  "transformed": {
    "type": "time-values",
    "content": [
      {
        "pointId": "point1",
        "timestamp": "2023-10-31T12:34:56.789Z"
      }
    ]
  }
}