History Queries

Update history query

Changed on

Updates an existing history query configuration

put/api/history/{historyId}

Request

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

Path parameters

historyIdstring required

Query parameters

resetCachestring 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

No Content

Changes

  • 0df3f625a5c2Revision changes
    • 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

  • 21b34a490fa3Revision 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

    • 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

    • warning

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