Jetstream API
...
API Endpoints
Device Commands

Restart a Device

8min

About

Instruct the specified device to restart.

Command Type

Device is Online

Device is Offline

Not Synchronous, Queueable

Immediate execution, 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.

Name

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/{Device Name}/reset

Request Body

None Required

Response Code

200 OK

Response Body

{ "CommandId": "0a80f878-8cdf-4265-beb9-2649e3affe36", "Status": "Queued", "ExceptionList": [], "OutputParameterList": [] }

Published CommandQueuedEvent

{ "Device": "MyDeviceName", "CommandId": "0a80f878-8cdf-4265-beb9-2649e3affe36", "CommandName": "ResetCommand", "URI": "/2/Devices/MyDeviceName/reset", "Verb": "Get", "User": "MyUserName", "Parameters": [], "Type": "CommandQueuedEvent", "EventId": "b705e17a-b64b-4bf1-bfb0-29f0b3ac1e23", "EventTime": "2017-05-17T19:57:52Z" }

Published CommandCompletionEvent

{ "CommandId": "0a80f878-8cdf-4265-beb9-2649e3affe36", "CommandName": "ResetCommand", "OutputParameterList": [], "ExceptionList": [], "Device": "MyDeviceName", "ReceivedTime": "2017-05-17T20:05:06Z", "Type": "CommandCompletionEvent", "EventId": "d8fc5071-c933-4b6a-b735-225b413e4894", "EventTime": "2017-05-17T20:05:29Z" }

Version Changes

Replaces ResetCommand