Set Configuration Values for a Device

9min

About
Queue a Set Config Values command to a specified device for specified parameters. This endpoint allows you to update a limited set of configuration values for your device without having to set all parameters for the device's policy. If a policy is added to the selected device after the Set Config Values command is queued, the policy settings will apply to the device and overwrite the Set Config Values parameters set. 
Command Type
Device is Online
Device is Offline
Synchronous, Queueable
Immediate execution, Immediate results and 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 in your user profile﻿.
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-_,. ]*$
ConfigValues
dictionary(string,string)
Required
Request Body
The configuration parameters and values to be applied to the device.
All values defined must be of the type (e.g., int, bool, string, float, datetime) defined in the associated device definition.
See the Device Types﻿ page for your device for additional information for each config value. 
Available ConfigValues
antennarxsensitivity
antenna1rxsensitivity
antenna2rxsensitivity
antenna3rxsensitivity
antenna4rxsensitivity
antennatxpower
antenna1txpower
antenna2txpower
antenna3txpower
antenna4txpower
dooropentimelimit
fieldofview
heartbeateventinterval
objecteventscantime
sensorreadingeventinterval
Example
Request URL
POST https://api.jetstreamrfid.com/3/devices/{Device Name}/configuration
Request Body
{
  "objecteventscantime": "60",
  "sensorreadingeventinterval": "60",
  "heartbeateventinterval": "60"
}
If your request body contains duplicate configuration values, the configuration value that is latest in the list will be applied. 
Response Code
200 OK
Response Body
{
  "CommandId": "string",
  "Status": "Queued",
  "ExceptionList": [],
  "OutputParameterList": [
      {
      "Key": "objecteventscantime",
      "Value": "60"
    },
      {
      "Key": "sensorreadingeventinterval",
      "Value": "60"
    },
      {
      "Key": "heartbeateventinterval",
      "Value": "60"
    }
  ]
}
Published CommandQueuedEvent
{
  "Uri": "string",
  "Type": "CommandQueuedEvent",
  "User": "string",
  "Verb": "Post",
  "Device": "string",
  "EventId": "string",
  "Version": 3,
  "CommandId": "string",
  "EventTime": "string",
  "Parameters": [
    {
      "Key": "objecteventscantime",
      "Value": "60"
    },
      {
      "Key": "sensorreadingeventinterval",
      "Value": "60"
    },
      {
      "Key": "heartbeateventinterval",
      "Value": "60"
    }
  ],
  "CommandName": "SetConfigValuesCommand"
}
Published CommandCompletionEvent
{
	"CommandId": "string",
	"CommandName": "SetConfigValuesCommand",
	"OutputParameterList": [
      {
      "Key": "objecteventscantime",
      "Value": "60"
    },
      {
      "Key": "sensorreadingeventinterval",
      "Value": "60"
    },
      {
      "Key": "heartbeateventinterval",
      "Value": "60"
    }
],
	"ExceptionList": [],
	"Device": "string",
	"ReceivedTime": "string",
	"Type": "CommandCompletionEvent",
	"EventId": "string",
	"EventTime": "string"
	"Version":3
}
Version Changes
None – this is a new endpoint.

Command Type	Device is Online	Device is Offline
Synchronous, Queueable	Immediate execution, Immediate results and Published results	Queued execution, Published results

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.
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-_,. ]*$
ConfigValues dictionary(string,string) Required	Request Body	The configuration parameters and values to be applied to the device. All values defined must be of the type (e.g., int, bool, string, float, datetime) defined in the associated device definition. See the Device Types page for your device for additional information for each config value. Available ConfigValues antennarxsensitivity antenna1rxsensitivity antenna2rxsensitivity antenna3rxsensitivity antenna4rxsensitivity antennatxpower antenna1txpower antenna2txpower antenna3txpower antenna4txpower dooropentimelimit fieldofview heartbeateventinterval objecteventscantime sensorreadingeventinterval

Updated 15 Jul 2024

Set a Device's Policy Parameters

Device Definition Configuration