Jetstream API
Event Types
CommandCompletionEvent
10min
CommandCompletionEvent is published when a command has been completed on a device. The CommandCompletionEvent will include any output parameters, exceptions, and device extensions for completing the command.
Property | Details |
|---|---|
Type string | The type of Jetstream event. |
EventId string
Unique | The ID assigned to the event. |
EventTime string | The time that the event occurred. The value is expressed in UTC. This value is expressed in the following format: yyyy-MM-ddTHH:mm:ssZ |
Version int | The Jetstream version of the event. |
Device string | The name of the device. |
CommandId string
Unique | The ID assigned to the command that was queued. |
CommandName string | The name of the command that was queued. |
Verb string | The HTTP verb the API endpoint was called with. |
User string | The username of the user that called the endpoint. |
OutputParameterList list (keyvaluepair
(string, string)) | A list of values that is returned from the device. This can be empty on both successful and failed commands. |
ExceptionList list (keyvaluepair
(string, string)) | A list of exceptions that occurred while completing the command. If the command was successfully completed, this will be empty. The most common exception is a command timeout, for example: "Key":"CommandTimedOut", "Value":"Command timed out after 1440 minutes. Queued Time = 3/8/2021 11:54:01 PM" |
Published CommandCompletionEvent for Sync Device Credentials
{
"CommandId": "0093fac7-1d82-430a-8bd2-0562c2067037",
"CommandName": "SyncCredentials",
"OutputParameterList": [],
"ExceptionList": [],
"Device": "MyDeviceName",
"ReceivedTime": "2018-05-16T21:17:13Z",
"Type": "CommandCompletionEvent",
"EventId": "59236a58-2581-4f10-be5c-44c11e681794",
"EventTime": "2018-05-16T21:17:12Z",
"Version": 2
}
Published CommandCompletionEvent for Get All RFID Tags
{
"CommandId": "6f05b39a-a7a8-4bff-b694-00117af4a6d4",
"CommandName": "GetEPCListCommand",
"OutputParameterList": [
{
"Key": "EPC",
"Value": "AD4424044149CB775C0000CB"
},
{
"Key": "EPC",
"Value": "AD44240441498F755B0000C5"
},
{
"Key": "EPC",
"Value": "AD4424044149A3795C0000C7"
},
{
"Key": "EPC",
"Value": "AD4424044149F1765B0000CF"
}
],
"ExceptionList": [],
"Device": "MyDeviceName",
"ReceivedTime": "2018-05-17T16:23:10Z",
"Type": "CommandCompletionEvent",
"EventId": "c5ec82de-2284-4156-aa09-092669115b27",
"EventTime": "2018-05-17T16:23:08Z",
"Version": 2
}
Published CommandCompletionEvent for Restart a Device
{
"CommandId": "0a80f878-8cdf-4265-beb9-2649e3affe36",
"CommandName": "ResetCommand",
"OutputParameterList": [],
"ExceptionList": [],
"Device": "MyDeviceName",
"ReceivedTime": "2018-05-17T20:05:06Z",
"Type": "CommandCompletionEvent",
"EventId": "d8fc5071-c933-4b6a-b735-225b413e4894",
"EventTime": "2018-05-17T20:05:29Z",
"Version": 2
}
Published CommandCompletionEvent for Lockdown a Device
{
"CommandId": "6bd4b8fb-d964-4d00-ae0a-e3943d58e004",
"CommandName": "Lockdown",
"OutputParameterList": [],
"ExceptionList": [],
"Device": "MyDeviceName",
"ReceivedTime": "2018-05-18T00:31:36Z",
"Type": "CommandCompletionEvent",
"EventId": "a0a1a21b-7537-4a75-9eee-cb2e9688f146",
"EventTime": "2018-05-18T00:31:35Z",
"Version": 2
}
Published CommandCompletionEvent for Unlock a Device's Door
{
"CommandId": "2b50fff0-e84c-42c1-b294-9eb6895684c3",
"CommandName": "UnlockDoor",
"OutputParameterList": [],
"ExceptionList": [],
"Device": "MyDeviceName",
"ReceivedTime": "2018-05-18T03:22:54Z",
"Type": "CommandCompletionEvent",
"EventId": "4aa5df90-bfea-49f7-8d69-bce6ba9e21fb",
"EventTime": "2018-05-18T03:22:52Z",
"Version": 2
}
Published CommandCompletionEvent for Get a Device's Policy Parameters
{
"CommandId": "e8498582-9ae3-4e82-a1f0-005ecce1ec7c",
"CommandName": "GetConfigValuesCommand",
"OutputParameterList": [
{
"Key": "aggregateeventscancount",
"Value": "2"
},
{
"Key": "aggregateeventscantime",
"Value": "10"
},
{
"Key": "antenna1rxsensitivity",
"Value": "50"
},
{
"Key": "antenna1txpower",
"Value": "30"
},
{
"Key": "antenna2rxsensitivity",
"Value": "50"
},
{
"Key": "antenna2txpower",
"Value": "30"
},
{
"Key": "antenna3rxsensitivity",
"Value": "50"
},
{
"Key": "antenna3txpower",
"Value": "30"
},
{
"Key": "antenna4rxsensitivity",
"Value": "50"
},
{
"Key": "antenna4txpower",
"Value": "30"
},
{
"Key": "commandpollinterval",
"Value": "60"
},
{
"Key": "dns",
"Value": "0.0.0.0"
},
{
"Key": "dooropentimelimit",
"Value": "300"
},
{
"Key": "gateway",
"Value": "0.0.0.0"
},
{
"Key": "ip",
"Value": "0.0.0.0"
},
{
"Key": "jetstreamdeviceurl",
"Value": "https://us-device.tersosolutions.com/v1.0/device/"
},
{
"Key": "lockdownhightemp",
"Value": "127"
},
{
"Key": "lockdownonacpowerfailure",
"Value": "0"
},
{
"Key": "lockdownonhightemp",
"Value": "0"
},
{
"Key": "lockdownonreaderfailure",
"Value": "0"
},
{
"Key": "logentryeventhightemp",
"Value": "127"
},
{
"Key": "logentryeventlowtemp",
"Value": "-128"
},
{
"Key": "logentrylevel",
"Value": "warning"
},
{
"Key": "numberofantennas",
"Value": "4"
},
{
"Key": "objecteventscancount",
"Value": "2"
},
{
"Key": "objecteventscantime",
"Value": "10"
},
{
"Key": "subnet",
"Value": "0.0.0.0"
}
],
"ExceptionList": [],
"Device": "MyDeviceName",
"ReceivedTime": "2018-05-18T20:55:12Z",
"Type": "CommandCompletionEvent",
"EventId": "c13a2d94-fb86-421d-9969-f56e3a44b280",
"EventTime": "2018-05-18T20:55:18Z",
"Version": 2
}
Published CommandCompletionEvent for Set a Device's Policy Parameters
{
"CommandId": "2bf00848-b06a-4820-86fc-58c12e08ee3e",
"CommandName": "SetConfigValuesCommand",
"OutputParameterList": [],
"ExceptionList": [],
"Device": "MyDeviceName",
"ReceivedTime": "2018-05-19T01:16:23Z",
"Type": "CommandCompletionEvent",
"EventId": "93723c89-cb44-44f0-8d86-87ede0fb3ba6",
"EventTime": "2018-05-19T01:16:19Z",
"Version": 2
}
- Replaced CommandCompletionEvents for Get All Passes, Add and/or Remove Passes, and Replace All Passes with the CommandCompletionEvents for Sync Device Credentials.
- Removed CommandCompletionEvent for Update Agent Firmware.
- Addition of the Version property.