ZeroKey

Historian

The Historian module provides logging and log exporting functionality for both positional and collision data.

Requests position updates events based on the requested filter conditions

SecurityOAuth2 or ApiKey
Request
Request Body schema: application/json

Requests position updates events based on the requested filter conditions

Array
StartTime
string <date-time>

The minimum date and time range used to filter positional data.

EndTime
string <date-time>

The maximum date and time range used to filter positional data.

DeviceID
string

A 6-byte MAC address associated to the device. This is usually the MAC address associated with the radio or Ethernet interface, depending on the particular device.

Responses
201

Response success

Response Schema: application/json
TaskID
string

The generated ID associated to the request task, used to retrieve the export file data after being notified of task completion

400

Malformed request.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden. Current token does not have the necessary authority for the operation.

422

Invalid data was sent.

post/modules/historian/positionUpdates
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "TaskID": "string"
}

Requests zone collisions events

SecurityOAuth2 or ApiKey
Request
Request Body schema: application/json

Requests zone collisions events based on the requested filter conditions

ZoneIDs
Array of strings

The list of zones to retrieve collision data for

Array of objects (DeviceFilter)

Specifies the list of device based filters that are involved in an collision

Array
StartTime
string <date-time>

The minimum date and time range used to filter positional data.

EndTime
string <date-time>

The maximum date and time range used to filter positional data.

DeviceID
string

A 6-byte MAC address associated to the device. This is usually the MAC address associated with the radio or Ethernet interface, depending on the particular device.

IncludePositionalData
boolean
Default: false

Indicates whether the filtered result should include the interleaved positional data, or not

Responses
201

Response success

Response Schema: application/json
TaskID
string

The generated ID associated to the request task, used to retrieve the export file data after being notified of task completion

400

Malformed request.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden. Current token does not have the necessary authority for the operation.

422

Invalid data was sent.

post/modules/historian/zoneCollisions
Request samples
application/json
{
  • "ZoneIDs": [
    ],
  • "Devices": [
    ],
  • "IncludePositionalData": false
}
Response samples
application/json
{
  • "TaskID": "string"
}

Retrieve the export file content

SecurityOAuth2 or ApiKey
Request
path Parameters
TaskID
required
string

ID from the previous export request

Example: b3ef466f-0486-469b-a9e1-04740a814af6
Responses
200

Response success.

Response Schema: application/json
AttachedFile
string

A Comma-Separated Values string of data

401

Unauthorized access, invalid credentials were used.

404

Resource was not found.

get/modules/historian/file/{TaskID}
Request samples 
Response samples 
application/json
{
  • "AttachedFile": "string"
}
Requests Workflow Run Data based on the requested filter conditions
SecurityOAuth2 or ApiKey 
Request 
Request Body schema: application/json
Requests Workflow Run Data based on the requested filter conditions


StartDateTime
string <date-time> 
The minimum date and time range used to filter workflow run data.


 
EndDateTime
string <date-time> 
The maximum date and time range used to filter workflow run data.


 
WorkflowIds
Array of arrays
The GUID identifier given to each workflow.


 
runIDs
Array of arrays
The GUID identifier given to each workflow run.


 
userIDs
Array of arrays
The GUID identifier given to each user.


 
lastNumberOfRuns
integer
The GUID identifier given to each user.


 
Responses 
201
Response success


Response Schema: application/json
ID
string
Unique identifier for the workflow run


 
WorkflowName
string
Name of the workflow


 
StationName
string
Name of the station where the workflow was executed


 
Username
string
Username of the person who ran the workflow


 
WorkflowStatus
string
Current status of the workflow run (e.g., Complete, Running, Failed)


 
StartDateTime
string <date-time> 
Date and time when the workflow started


 
EndDateTime
string <date-time> 
Date and time when the workflow ended


 
object
Dictionary of workflow steps with their details and any associated data


 
property name*
additional property
Array of any
 
400
Malformed request.


401
Unauthorized access, invalid credentials were used.


403
Access forbidden. Current token does not have the necessary authority for the operation.


422
Invalid data was sent.


post/modules/historian/workflowRunsData
Request samples 
application/json
{
  • "StartDateTime": "2019-08-24T14:15:22Z",
  • "EndDateTime": "2019-08-24T14:15:22Z",
  • "WorkflowIds": [
    ],
  • "runIDs": [
    ],
  • "userIDs": [
    ],
  • "lastNumberOfRuns": 10
}
Response samples 
application/json
{
  • "ID": "string",
  • "WorkflowName": "string",
  • "StationName": "string",
  • "Username": "string",
  • "WorkflowStatus": "string",
  • "StartDateTime": "2019-08-24T14:15:22Z",
  • "EndDateTime": "2019-08-24T14:15:22Z",
  • "WorkflowRunSteps": {
    }
}
➔ Next to MQTT