Jetstream API
...
API Endpoints
Device Configuration
Modify a Device
6min
about overwrite the name, serial number, device definition, or aliases of the specified device with a new name, serial number, device definition, or aliases parameters property location details accesskey string required unique header the access key for your user account this value is a 36 character guid provided in your getting started docid\ bbifqiuixnd5iafmrebbi devicename string required unique url the existing 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 , ] $ id ulong unique body response the id assigned to the newly created device this value is generated by jetstream – do not define it in requests name string required unique body request response 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 ] $ serialnumber string required unique body request response the physical serial number 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 ] $ devicedefinition string required body request response the name of the device definition associated with the device this value is one of the device definitions retrieved by the get all device definitions docid\ zre5zpbxavj78epzuxb84 request this value has a max length of 128 ascii characters this value must adhere to this regular expression ^\[a za z0 9 , ] $ region string body response the geographic region that the rfid device is being placed this is used to create the most reliable and lowest latency connection to the device this value is one of the following possibilities us, eu, ap, usgov policy string body response the name of the policy associated with the device this value is set via the add a policy to a device docid 8iinkl mz80hpiut5zv2e request attempting to set this any other way or not defining this property will result in an empty string value aliases array(string) required unique body request response the names of the aliases that the device can assume each value has a max length of 128 ascii characters each value must adhere to this regular expression ^\[a za z0 9 , ] $ if the aliases that the device can assume is/are not changing, define the existing alias names if the name of the device is not changing, the defined aliases will be associated with the existing device name if the name of the device is changing, the defined aliases will be associated with the new device name this property is required and must be included with all requests if there are no aliases to define, define an empty array example request url put https //api jetstreamrfid com/3/devices/{device name} request body { "name" "mynewdevicename", "serialnumber" "myexistingdeviceserialnumber", "devicedefinition" "ts084, handheld, us, uhf", "region" "us", "policy" "", "aliases" \[ "myaliasname1", "myaliasname2", "mynewaliasname3" ] } response code 200 ok response body { "id" 1, "name" "mynewdevicename", "serialnumber" "myexistingdeviceserialnumber", "devicedefinition" "ts084, handheld, us, uhf", "region" "us", "policy" "", "aliases" \[ "myaliasname1", "myaliasname2", "mynewaliasname3" ] } version changes none – this is a new endpoint