Sign in
History Queries

List all history queries

Retrieves a list of all configured history queries

get/api/history

Response

Array of history query objects

idstring required

The unique identifier of the entity.

createdAtstring required

Represents an instant in time as an ISO 8601 string.

updatedAtstring required

Represents an instant in time as an ISO 8601 string.

namestring required

The name of the history query.

descriptionstring required

Description of the history query's purpose.

status'PENDING' | 'RUNNING' | 'ERRORED' | 'PAUSED' | 'FINISHED' required

Type representing the possible statuses for a history query.

startTimestring required

Start time for the data to be queried (ISO 8601 format).

endTimestring required

End time for the data to be queried (ISO 8601 format).

southType'opcua' | 'mqtt' | 'modbus' | 'oianalytics' | 'ads' | '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.

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.

currentItemNumbernumber double

The 1-based index of the item currently being queried, among the run's enabled items. Only set while the history query is actively running on a connector that queries items one at a time (SOUTH_SINGLE_ITEMS).

numberOfItemsnumber double

The total number of enabled items in the run. Only set while the history query is actively running on a connector that queries items one at a time (SOUTH_SINGLE_ITEMS).

Example response

[
  {
    "id": "entity123",
    "createdBy": {
      "id": "abc123",
      "friendlyName": "John Doe (john.doe)"
    },
    "updatedBy": {
      "id": "abc123",
      "friendlyName": "John Doe (john.doe)"
    },
    "createdAt": "2023-10-31T12:34:56.789Z",
    "updatedAt": "2023-10-31T12:34:56.789Z",
    "name": "Production Data Migration",
    "description": "Migrate production data from old to new system",
    "startTime": "2023-01-01T00:00:00Z",
    "endTime": "2023-01-31T23:59:59Z",
    "currentItemNumber": 3,
    "numberOfItems": 10
  }
]

Changes