Create a Device

6min

About
Add a device to your Jetstream application, making the device ready to receive your commands and push events.
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 user profile﻿.
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-_,. ]*$
The proper device definition for your device can always be provided by Terso Support.
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-_,. ]*$
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
POST https://api.jetstreamrfid.com/3/devices
Request Body
{
    "Name": "MyDeviceName",
    "SerialNumber": "MyDeviceSerialNumber",
    "DeviceDefinition": "TS032, Cabinet, US, UHF, GF, 7.9 cu ft, v4",
    "Region": "US",
    "Aliases": [ 
            "MyAliasName1",  
            "MyAliasName2" 
    ]
}
Response Code
201 Created
Response Body
{
    "Id": 1,
    "Name": "MyDeviceName",
    "SerialNumber": "MyDeviceSerialNumber",
    "DeviceDefinition": "TS032, Cabinet, US, UHF, GF, 7.9 cu ft, v4",
    "Region": "US",
    "Policy": "",
    "Aliases": [ 
            "MyAliasName1",  
            "MyAliasName2" 
    ]
}
Version Changes
Addition of the Id property.
Addition of the Aliases property.
Generates a DeviceAddedEvent﻿.
﻿

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 user profile.
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-_,. ]*$ The proper device definition for your device can always be provided by Terso Support.
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-_,. ]*$ This property is required and must be included with all requests. If there are no aliases to define, define an empty array.

Updated 30 Jan 2024

Device Configuration

Modify a Device