History Queries

Test history query item

Changed on

Test a history query item

post/api/history/{historyId}/test/items

Request

  • Base URL: http://localhost:2223
  • URL: http://localhost:2223/api/history/{historyId}/test/items
  • Auth: none required

Path parameters

historyIdstring required

Query parameters

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

Type representing the possible types for a South connector.

itemNamestring required
fromSouthstring required

Request body

Example request

{
  "itemSettings": {
    "timezone": "Europe/Paris"
  }
}

Response

Ok

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"
      }
    ]
  }
}

Changes

    • breaking

      added the new required request property /////

    • breaking

      added the new required request property /////

    • breaking

      added the new required request property /////

    • breaking

      added the new required request property /////

    • breaking

      added the new required request property /////

    • warning

      removed the request property /////

    • warning

      removed the request property /////

    • warning

      removed the request property /////

    • warning

      removed the request property /////

    • warning

      removed the request property /////

    • warning

      removed the request property /////

    • warning

      removed the request property /////

    • warning

      removed the request property /////

    • warning

      removed the request property /////

    • warning

      removed the request property /////

    • info

      added the new enum value bacnet to the query request parameter southType

    • info

      added the new enum value mongodb to the query request parameter southType

    • info

      added the new enum value s7 to the query request parameter southType

    • info

      added to the request property anyOf list

    • info

      added to the request property anyOf list

    • info

      added to the response property anyOf list for the response status

    • info

      added to the //// response property anyOf list for the response status

    • breaking

      added the new required request property /////

    • breaking

      added the new required request property /////

    • breaking

      added the new required request property /////

    • breaking

      added the new required request property /////

    • breaking

      added the new required request property /////

    • breaking

      added the new required request property /////

    • breaking

      added the new required request property /////

    • breaking

      added the new required request property /////

    • breaking

      added the new required request property /////

    • breaking

      added the new required request property /////

    • breaking

      removed the enum value bacnet from the query request parameter southType

    • breaking

      removed the enum value mongodb from the query request parameter southType

    • breaking

      removed the enum value s7 from the query request parameter southType

    • breaking

      removed from the request property anyOf list

    • breaking

      removed from the request property anyOf list

    • warning

      removed the request property /////

    • warning

      removed the request property /////

    • warning

      removed the request property /////

    • warning

      removed the request property /////

    • warning

      removed the request property /////

    • info

      removed from the response property anyOf list for the response status

    • info

      removed from the //// response property anyOf list for the response status