Get a Device Definition

5min

About
Return a specified device definition from Jetstream.
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﻿.
DeviceDefinitionName
string
Required
Unique
URL
The name of the device definition.
This value has a max length of 128 ASCII characters.
This value must adhere to this regular expression: ^[a-zA-Z0-9-_,. ]*$
Example
Request URL
GET https://api.jetstreamrfid.com/3/devicedefinitions/{DeviceDefinitionName}

Request Body
None Required

Response Code
200 OK

Response Body
{
	"Id": 76,
        "Name": "TS032, Cabinet, US, UHF, GF, 7.9 cu ft",
	"FirmwareVersion": "3.31",
	"GetConfigValuesCommand": true,
	"SetConfigValuesCommand": true,
	"GetEpcListCommand": true,
	"ResetCommand": true,
	"UpdateFirmwareCommand": true,
	"DeviceSpecificCommandNames": [
		"GetPasses",
		"Lockdown  ",
		"UpdatePasses"
	],
	"ConfigParameters": {
		"aggregateeventscancount": "int",
		"aggregateeventscantime": "int",
		"antenna1rxsensitivity": "int",
		"antenna1txpower": "int",
		"antenna2rxsensitivity": "int",
		"antenna2txpower": "int",
		"antenna3rxsensitivity": "int",
		"antenna3txpower": "int",
		"antenna4rxsensitivity": "int",
		"antenna4txpower": "int",
		"commandpollinterval": "int",
		"dns": "string",
		"dooropentimelimit": "int",
		"gateway": "string",
		"ip": "string",
		"jetstreamdeviceurl": "string",
		"lockdownhightemp": "int",
		"lockdownonacpowerfailure": "bool",
		"lockdownonhightemp": "bool",
		"lockdownonreaderfailure": "bool",
		"logentryeventhightemp": "int",
		"logentryeventlowtemp": "int",
		"logentrylevel": "string",
		"numberofantennas": "int",
		"objecteventscancount": "int",
		"objecteventscantime": "int",
		"subnet": "string"
	},
	"SensorReadingMeasures": {
		"TemperatureA": "C",
		"TemperatureB": "C"
	}
}
Version Changes
none

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.
DeviceDefinitionName string Required Unique	URL	The name of the device definition. This value has a max length of 128 ASCII characters. This value must adhere to this regular expression: ^[a-zA-Z0-9-_,. ]*$

Updated 30 Jan 2024

Device Definition Configuration

Get All Device Definitions