Jetstream API
Event Types
CommandQueuedEvent
10min
about commandqueuedevent signals when any user of your application has queued a command commandqueuedevent is useful for keeping multiple components of your application in sync with each other for command information 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 uri string the uri of the endpoint that was called to generate this queued event verb string the http verb the api endpoint was called with user string the username of the user that called the endpoint parameters list (keyvaluepair (string, string)) a list of values that a device will act on examples published commandqueuedevent for sync device credentials docid\ l7ik ra1wcy3phhm0fwqs { "device" "mydevicename", "commandid" "5be4a19c f1c3 42a9 b437 eacf5272bb8d", "commandname" "updatepasses", "uri" "/3/devices/mydevicename/credentials/sync", "verb" "post", "user" "myusername", "parameters" \[ { "key" "add", "value" "mybasiccredentials1 value" }, { "key" "add", "value" "mybasiccredentials2 value" }, { "key" "add", "value" "mybasiccredentials3 value" }, { "key" "remove", "value" " " } ], "type" "commandqueuedevent", "eventid" "7e830645 0c77 4a1d 9666 1e5b6c320947", "eventtime" "2018 05 17t13 51 08z", "version" 3 } published commandqueuedevent for get all rfid tags docid 7onvtntdtfl9ptdal2nvo { "device" "mydevicename", "commandid" "6f05b39a a7a8 4bff b694 00117af4a6d4", "commandname" "getepclistcommand", "uri" "/3/devices/mydevicename/epclist", "verb" "get", "user" "myusername", "parameters" \[], "type" "commandqueuedevent", "eventid" "14858b69 f6ce 414d b64b 531e1a0a06f4", "eventtime" "2018 05 17t16 22 29z", "version" 3 } published commandqueuedevent for restart a device docid\ ww54y7kiqnfvyk8zyqakv { "device" "mydevicename", "commandid" "0a80f878 8cdf 4265 beb9 2649e3affe36", "commandname" "resetcommand", "uri" "/3/devices/mydevicename/reset", "verb" "post", "user" "myusername", "parameters" \[], "type" "commandqueuedevent", "eventid" "b705e17a b64b 4bf1 bfb0 29f0b3ac1e23", "eventtime" "2017 05 17t19 57 52z", "version" 3 } published commandqueuedevent for lockdown a device docid\ vboyeohcjlpy 7zr afgz { "device" "mydevicename", "commandid" "6bd4b8fb d964 4d00 ae0a e3943d58e004", "commandname" "lockdown", "uri" "/3/devices/mydevicename/lockdown", "verb" "post", "user" "myusername", "parameters" \[ { "key" "hours", "value" "1" } ], "type" "commandqueuedevent", "eventid" "98115b7b 3f7f 439b ba27 ac1234d7569c", "eventtime" "2018 05 18t00 31 20z", "version" 3 } published commandqueuedevent for unlock a device's door docid 1 ro5cpawezhguxfhofai { "device" "mydevicename", "commandid" "2b50fff0 e84c 42c1 b294 9eb6895684c3", "commandname" "unlockdoor", "uri" "/3/devices/mydevicename/unlockdoor", "verb" "post", "user" "myusername", "parameters" \[ { "key" "accesstoken", "value" "myaccesstoken" } ], "type" "commandqueuedevent", "eventid" "80476d30 8d3b 415e 9966 6e5d63876ad9", "eventtime" "2018 05 18t03 22 37z", "version" 3 } published commandqueuedevent for get a device's policy parameters docid\ g6s4nzg5dsgaf dcagbtb { "device" "mydevicename", "commandid" "e8498582 9ae3 4e82 a1f0 005ecce1ec7c", "commandname" "getconfigvaluescommand", "uri" "/3/devices/mydevicename/policy/sync", "verb" "get", "user" "myusername", "parameters" \[ { "key" "parameter0", "value" "aggregateeventscancount" }, { "key" "parameter1", "value" "aggregateeventscantime" }, { "key" "parameter2", "value" "antenna1rxsensitivity" }, { "key" "parameter3", "value" "antenna1txpower" }, { "key" "parameter4", "value" "antenna2rxsensitivity" }, { "key" "parameter5", "value" "antenna2txpower" }, { "key" "parameter6", "value" "antenna3rxsensitivity" }, { "key" "parameter7", "value" "antenna3txpower" }, { "key" "parameter8", "value" "antenna4rxsensitivity" }, { "key" "parameter9", "value" "antenna4txpower" }, { "key" "parameter10", "value" "commandpollinterval" }, { "key" "parameter11", "value" "dns" }, { "key" "parameter12", "value" "dooropentimelimit" }, { "key" "parameter13", "value" "gateway" }, { "key" "parameter14", "value" "ip" }, { "key" "parameter15", "value" "jetstreamdeviceurl" }, { "key" "parameter16", "value" "lockdownhightemp" }, { "key" "parameter17", "value" "lockdownonacpowerfailure" }, { "key" "parameter18", "value" "lockdownonhightemp" }, { "key" "parameter19", "value" "lockdownonreaderfailure" }, { "key" "parameter20", "value" "logentryeventhightemp" }, { "key" "parameter21", "value" "logentryeventlowtemp" }, { "key" "parameter22", "value" "logentrylevel" }, { "key" "parameter23", "value" "numberofantennas" }, { "key" "parameter24", "value" "objecteventscancount" }, { "key" "parameter25", "value" "objecteventscantime" }, { "key" "parameter26", "value" "subnet" } ], "type" "commandqueuedevent", "eventid" "fe971dbc a783 458c 9096 ea2869956fae", "eventtime" "2017 05 18t20 55 09z", "version" 3 } published commandqueuedevent for set a device's policy parameters docid\ g2ehibf dqnwc4nh0cx1w { "device" "mydevicename", "commandid" "2bf00848 b06a 4820 86fc 58c12e08ee3e", "commandname" "setconfigvaluescommand", "uri" "/3/devices/mydevicename/policy/sync", "verb" "post", "user" "myusername", "parameters" \[ { "key" "aggregateeventscancount", "value" "4" } ], "type" "commandqueuedevent", "eventid" "f3df515b c53a 4b3b b3e9 01ffe6ffd8f3", "eventtime" "2017 05 19t01 16 21z", "version" 3 } version changes replaced commandqueuedevents for get all passes, add and/or remove passes, and replace all passes with the commandqueuedevent for sync device credentials removed commandqueuedevent for update agent firmware addition of the version property