Jetstream API
Event Types
CommandCompletionEvent
10 min
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 the type of jetstream event eventid the id assigned to the event eventtime 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 the jetstream version of the event device the name of the device commandid the id assigned to the command that was queued commandname the name of the command that was queued verb the http verb the api endpoint was called with user the username of the user that called the endpoint outputparameterlist a list of values that is returned from the device this can be empty on both successful and failed commands exceptionlist 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 published commandcompletionevent for get all rfid tags docid 7onvtntdtfl9ptdal2nvo published commandcompletionevent for restart a device docid\ ww54y7kiqnfvyk8zyqakv published commandcompletionevent for lockdown a device docid\ vboyeohcjlpy 7zr afgz published commandcompletionevent for unlock a device's door docid 1 ro5cpawezhguxfhofai published commandcompletionevent for get a device's policy parameters docid\ g6s4nzg5dsgaf dcagbtb published commandcompletionevent for set a device's policy parameters docid\ g2ehibf dqnwc4nh0cx1w 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