History Queries

Create history query

Changed on

Creates a new history query with the provided configuration

post/api/history

Request

  • Base URL: http://localhost:2223
  • URL: http://localhost:2223/api/history
  • Auth: none required

Query parameters

fromSouthstring required
fromNorthstring required
duplicatestring required

Request body

namestring required
descriptionstring required
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.

southSettingsobject required
northType'opcua' | 'mqtt' | 'modbus' | 'oianalytics' | 'rest' | 'sftp' | 'aws-s3' | 'azure-blob' | 'azure-data-explorer' | 'console' | 'file-writer' required

Type representing the possible types for a North connector.

northSettingsobject required

Example request

{
  "queryTimeRange": {
    "endTime": "2023-10-31T12:34:56.789Z",
    "startTime": "2023-10-31T12:34:56.789Z"
  },
  "northTransformers": [
    {
      "id": "id",
      "items": [
        {
          "enabled": true,
          "name": "Temperature Logs"
        }
      ]
    }
  ]
}

Response

Created

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Changes

    • breaking

      the response property /////////////// became nullable for the status

    • breaking

      the response property /////////////// became nullable for the status

    • info

      added the new azure-data-explorer enum value to the request property

    • info

      added the new bacnet enum value to the request property

    • info

      added the new mongodb enum value to the request property

    • info

      added the new s7 enum value to the request property

    • info

      added subschema #3 subschema #4 to the response body allOf list for the response status

    • info

      removed subschema #3 subschema #4 from the response body allOf list for the response status

    • info

      added the required property /////// to the response with the status

    • info

      added the required property /////// to the response with the status

    • info

      added the required property /////// to the response with the status

    • info

      added the required property /////// to the response with the 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

      the request's body type changed from no type to object

    • breaking

      removed the required property /////// from the response with the status

    • breaking

      removed the required property /////// from the response with the status

    • breaking

      removed the required property /////// from the response with the status

    • breaking

      removed the required property /////// from the response with the status

    • warning

      removed subschema #2 subschema #3 from the request body allOf list

    • info

      added subschema #3 subschema #4 to the response body allOf list for the response status

    • info

      removed subschema #3 subschema #4 from the response body allOf list for the response status