Modify a Device

Overwrite the name, serial number, device definition, and/or aliases of the specified device with a new name, serial number, device definition, and/or aliases.

Property Location Details

AccessKey

string
Required
Unique

Header

The access key for your user account.

This value is a 36-character GUID provided during user account sign up.

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 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
Required

Body

Request 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 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.

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"
    ]
}
None – this is a new endpoint