Jetstream API
Event Types
CommandCompletionEvent
10min
about 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 fields 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" example published commandcompletionevent for sync device credentials docid\ l7ik ra1wcy3phhm0fwqs { "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 docid 7onvtntdtfl9ptdal2nvo { "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 docid\ ww54y7kiqnfvyk8zyqakv { "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 docid\ vboyeohcjlpy 7zr afgz { "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 docid 1 ro5cpawezhguxfhofai { "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 docid\ g6s4nzg5dsgaf dcagbtb { "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 docid\ g2ehibf dqnwc4nh0cx1w { "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 } version changes 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