Jetstream API
...
API Endpoints
Device Commands

Set a Device's Configuration Parameters

8min

About

Instruct the specified device to set/sync its configuration parameters and values to user provided parameters and values, which are defined within the Parameters property of the Add a Policy to a Device request. Complete documentation on a device’s configuration parameters and values can be found on its device types page.

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 during user account sign up.

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-_]*$

Example

Request URL

POST https://api.jetstreamrfid.com/2/devices/{DeviceName}/policy/sync

Request Body

None Required

Response Code

200 OK

Response Body

{ "CommandId": "2bf00848-b06a-4820-86fc-58c12e08ee3e", "Status": "Completed", "ExceptionList": [], "OutputParameterList": [ { "Key": "aggregateeventscancount", "Value": "4" } ] }

Published CommandQueuedEvent

{ "Device": "MyDeviceName", "CommandId": "2bf00848-b06a-4820-86fc-58c12e08ee3e", "CommandName": "SetConfigValuesCommand", "URI": "/2/Devices/MyDeviceName/policy/sync", "Verb": "Post", "User": "MyUserName", "Parameters": [ { "Key": "aggregateeventscancount", "Value": "4" } ], "Type": "CommandQueuedEvent", "EventId": "f3df515b-c53a-4b3b-b3e9-01ffe6ffd8f3", "EventTime": "2017-05-19T01:16:21Z" }

Published CommandCompletionEvent

{ "CommandId": "2bf00848-b06a-4820-86fc-58c12e08ee3e", "CommandName": "SetConfigValuesCommand", "OutputParameterList": [], "ExceptionList": [], "Device": "MyDeviceName", "ReceivedTime": "2017-05-19T01:16:23Z", "Type": "CommandCompletionEvent", "EventId": "93723c89-cb44-44f0-8d86-87ede0fb3ba6", "EventTime": "2017-05-19T01:16:19Z" }

Version Changes

Replaces SetConfigValuesCommand