About

Add a policy to your Jetstream application for managing a device's configuration values (the configuration parameters are defined by the device’s definition). A policy may be added to a device to apply its configuration settings.

Parameters

PropertyLocationDetails

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 Policy.

This value is generated by Jetstream – do not define it in requests.

Name

string
Required
Unique

Body

Request

Response

The name of the policy.

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 policy.

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

Parameters

dictionary(string,string)
Required

Body

Request

Response

The parameters and values associated with the policy.

All parameters defined in the associated device definition must be defined.

All values defined must be of the type (e.g., int, bool, string, float, datetime) defined in the associated device definition.

Example

Request URL

POST https://api.jetstreamrfid.com/3/policies

Request Body

{
    "Name": "MyPolicyName",
    "DeviceDefinition":"TS032, Cabinet, US, UHF, GF, 7.9 cu ft",
    "Parameters":{
        "aggregateeventscancount": 2,
        "aggregateeventscantime": 10,
        "antenna1rxsensitivity": 50,
        "antenna1txpower": 30,
        "antenna2rxsensitivity": 50,
        "antenna2txpower": 30,
        "antenna3rxsensitivity": 50,
        "antenna3txpower": 30,
        "antenna4rxsensitivity": 50,
        "antenna4txpower": 30,
        "commandpollinterval": 60,
        "dns": "0.0.0.0",
        "dooropentimelimit": 300,
        "gateway": "0.0.0.0",
        "ip": "0.0.0.0",
        "jetstreamdeviceurl": "https://usdevice.tersosolutions.com/v1.0/device/",
        "lockdownhightemp": 127,
        "lockdownonacpowerfailure": 0,
        "lockdownonhightemp": 0,
        "lockdownonreaderfailure": 0,
        "logentryeventhightemp": 127,
        "logentryeventlowtemp": -128,
        "logentrylevel": "warning",
        "numberofantennas": 4,
        "objecteventscancount": 2,
        "objecteventscantime": 10,
        "subnet": "0.0.0.0"
    }
}

Response Code

201 Created

Response Body

{
    "Id": 1,
    "Name": "MyPolicyName",
    "DeviceDefinition": "TS032, Cabinet, US, UHF, GF, 7.9 cu ft",
    "Parameters": {
        "aggregateeventscancount": "2",
        "aggregateeventscantime": "10",
        "antenna1rxsensitivity": "50",
        "antenna1txpower": "30",
        "antenna2rxsensitivity": "50",
        "antenna2txpower": "30",
        "antenna3rxsensitivity": "50",
        "antenna3txpower": "30",
        "antenna4rxsensitivity": "50",
        "antenna4txpower": "30",
        "commandpollinterval": "60",
        "dns": "0.0.0.0",
        "dooropentimelimit": "300",
        "gateway": "0.0.0.0",
        "ip": "0.0.0.0",
        "jetstreamdeviceurl": "https://usdevice.tersosolutions.com/v1.0/device/",
        "lockdownhightemp": "127",
        "lockdownonacpowerfailure": "0",
        "lockdownonhightemp": "0",
        "lockdownonreaderfailure": "0",
        "logentryeventhightemp": "127",
        "logentryeventlowtemp": "-128",
        "logentrylevel": "warning",
        "numberofantennas": "4",
        "objecteventscancount": "2",
        "objecteventscantime": "10",
        "subnet": "0.0.0.0"
    },
}

Version Changes

Addition of the Id property.