Update Firmware

8 min

about instruct the specified device to update the agent firmware from a specified url command type device is online device is offline not synchronous, queueable immediate execution, published results queued execution, published results parameters property location details accesskey string required unique header the access key for your user account this value is a 36 character guid provided during https //jetstreamrfid com/login/signup devicename string required unique url the name of the device this value has a max length of 128 ascii characters this value must adhere to this regular expression ^\[a za z0 9 ] $ newdevicedefinition string body the device will be updated to this specified device definition this value is one of the device definitions retrieved by the docid\ xnmyd7x5iixvo71ofvqoz request this value has a max length of 128 ascii characters this value must adhere to this regular expression ^\[a za z0 9 , ] $ url string required body the url containing the new firmware file if updating the agent from firmware version 3 to 4, this value must be a version number in the following format major version minor version if updating the agent from firmware version 4 to 4+, this value must be a validly formatted http or https url component string required body the firmware component that is being upgraded if updating the agent from firmware version 3 to 4, this value is the following agent if updating the agent from firmware version 4 to 4+, this value is the following agent examples example update agent firmware v3 to v4 post https //api jetstreamrfid com/2/devices/{devicename}/version { 	"url" "04 00", 	"component" "agent" } 200 ok { 	"commandid" "527a2f74 af29 410a 8ecb 7ec9f756079a", 	"status" "queued", 	"exceptionlist" \[], 	"outputparameterlist" \[] } { 	"device" "mydevicename", 	"commandid" "527a2f74 af29 410a 8ecb 7ec9f756079a", 	"commandname" "updatefirmwarecommand", 	"uri" "/2/devices/mydevicename/version", 	"verb" "post", 	"user" "myusername", 	"parameters" \[ 	 { 	 "key" "component", 	 "value" "agent" 	 }, 	 { 	 "key" "url", 	 "value" "04 00" 	 } 	], 	"type" "commandqueuedevent", 	"eventid" "55d8b7f7 63ad 446f a230 e8f8829a0dbd", 	"eventtime" "2017 05 19t21 06 49z" } none published example update agent firmware v4 to v4+ post https //api jetstreamrfid com/2/devices/{devicename}/version { 	"url" "myurl", 	"component" "agent" } 200 ok { 	"commandid" "527a2f74 af29 410a 8ecb 7ec9f756079a", 	"status" "queued", 	"exceptionlist" \[], 	"outputparameterlist" \[] } { 	"device" "mydevicename", 	"commandid" "527a2f74 af29 410a 8ecb 7ec9f756079a", 	"commandname" "updatefirmwarecommand", 	"uri" "/2/devices/mydevicename/version", 	"verb" "post", 	"user" "myusername", 	"parameters" \[ 	 { 	 "key" "component", 	 "value" "agent" 	 }, 	 { 	 "key" "url", 	 "value" "myurl" 	 } 	], 	"type" "commandqueuedevent", 	"eventid" "55d8b7f7 63ad 446f a230 e8f8829a0dbd", 	"eventtime" "2017 05 19t21 06 49z" } { 	"commandid" "527a2f74 af29 410a 8ecb 7ec9f756079a", 	"commandname" "updatefirmwarecommand", 	"outputparameterlist" \[], 	"exceptionlist" \[], 	"device" "mydevicename", 	"receivedtime" "2017 05 19t21 17 05z", 	"type" "commandcompletionevent", 	"eventid" "3a9387ce e797 4330 9a49 3f0c582c4721", 	"eventtime" "2017 05 19t21 16 46z" } version changes replaces updatefirmwarecommand