CommandQueuedEvent

CommandQueuedEvent signals when any user of your application has queued a command. CommandQueuedEvent is useful for keeping multiple components of your application in sync with each other for command information.

Property Details

Type

string
The type of Jetstream event.

EventId

string
Unique
The ID assigned to the event.

EventTime

string

The time that the event occurred.

The value is expressed in UTC.

This value is expressed in the following format: yyyy-MM-ddTHH:mm:ssZ

Version

int

The Jetstream version of the event.

Device

string

The name of the device.

CommandId

string
Unique

The ID assigned to the command that was queued.

CommandName

string

The name of the command that was queued.

URI

string

The URI of the endpoint that was called to generate this queued event.

Verb

string

The HTTP verb the API endpoint was called with.

User

string

The username of the user that called the endpoint.

Parameters

list (keyvaluepair
(string, string))

A list of values that a device will act on.

Published CommandQueuedEvent for Sync Device Credentials

{
    "Device": "MyDeviceName",
    "CommandId": "5be4a19c-f1c3-42a9-b437-eacf5272bb8d",
    "CommandName": "SyncCredentials",
    "URI": "/3/Devices/MyDeviceName/credentials/sync",
    "Verb": "Post",
    "User": "MyUserName",
    "Parameters": [
        {
            "Key": "Add",
            "Value": "MyBasicCredentials1_Value"
        },
        {
            "Key": "Add",
            "Value": "MyBasicCredentials2_Value"
        },
        {
            "Key": "Add",
            "Value": "MyBasicCredentials3_Value"
        },
        {
            "Key": "Remove",
            "Value": "*"
        }
    ],
    "Type": "CommandQueuedEvent",
    "EventId": "7e830645-0c77-4a1d-9666-1e5b6c320947",
    "EventTime": "2018-05-17T13:51:08Z",
    "Version": 3
}

Published CommandQueuedEvent for Get All RFID Tags

{
    "Device": "MyDeviceName",
    "CommandId": "6f05b39a-a7a8-4bff-b694-00117af4a6d4",
    "CommandName": "GetEPCListCommand",
    "URI": "/3/Devices/MyDeviceName/epclist",
    "Verb": "Get",
    "User": "MyUserName",
    "Parameters": [],
    "Type": "CommandQueuedEvent",
    "EventId": "14858b69-f6ce-414d-b64b-531e1a0a06f4",
    "EventTime": "2018-05-17T16:22:29Z",
    "Version": 3
}

Published CommandQueuedEvent for Restart a Device

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

Published CommandQueuedEvent for Lock a Device

{
    "Device": "MyDeviceName",
    "CommandId": "6bd4b8fb-d964-4d00-ae0a-e3943d58e004",
    "CommandName": "Lockdown",
    "URI": "/3/Devices/MyDeviceName/lockdown",
    "Verb": "Post",
    "User": "MyUserName",
    "Parameters": [
        {
            "Key": "Hours",
            "Value": "1"
        }
    ],
    "Type": "CommandQueuedEvent",
    "EventId": "98115b7b-3f7f-439b-ba27-ac1234d7569c",
    "EventTime": "2018-05-18T00:31:20Z",
    "Version": 3
 }

Published CommandQueuedEvent for Unlock a Device’s Door

{
    "Device": "MyDeviceName",
    "CommandId": "2b50fff0-e84c-42c1-b294-9eb6895684c3",
    "CommandName": "UnlockDoor",
    "URI": "/3/Devices/MyDeviceName/unlockdoor",
    "Verb": "Post",
    "User": "MyUserName",
    "Parameters": [
        {
            "Key": "AccessToken",
            "Value": "MyAccessToken"
        }
    ],
    "Type": "CommandQueuedEvent",
    "EventId": "80476d30-8d3b-415e-9966-6e5d63876ad9",
    "EventTime": "2018-05-18T03:22:37Z",
    "Version": 3
}

Published CommandQueuedEvent for Get a Device’s Configuration Parameters

{
    "Device": "MyDeviceName",
    "CommandId": "e8498582-9ae3-4e82-a1f0-005ecce1ec7c",
    "CommandName": "GetConfigValuesCommand",
    "URI": "/3/Devices/MyDeviceName/policy/sync",
    "Verb": "Get",
    "User": "MyUserName",
    "Parameters": [
        {
            "Key": "Parameter0",
            "Value": "aggregateeventscancount"
        },
        {
            "Key": "Parameter1",
            "Value": "aggregateeventscantime"
        },
        {
            "Key": "Parameter2",
            "Value": "antenna1rxsensitivity"
        },
        {
            "Key": "Parameter3",
            "Value": "antenna1txpower"
        },
        {
            "Key": "Parameter4",
            "Value": "antenna2rxsensitivity"
        },
        {
            "Key": "Parameter5",
            "Value": "antenna2txpower"
        },
        {
            "Key": "Parameter6",
            "Value": "antenna3rxsensitivity"
        },
        {
            "Key": "Parameter7",
            "Value": "antenna3txpower"
        },
        {
            "Key": "Parameter8",
            "Value": "antenna4rxsensitivity"
        },
        {
            "Key": "Parameter9",
            "Value": "antenna4txpower"
        },
        {
            "Key": "Parameter10",
            "Value": "commandpollinterval"
        },
        {
            "Key": "Parameter11",
            "Value": "dns"
        },
        {
            "Key": "Parameter12",
            "Value": "dooropentimelimit"
        },
        {
            "Key": "Parameter13",
            "Value": "gateway"
        },
        {
            "Key": "Parameter14",
            "Value": "ip"
        },
        {
            "Key": "Parameter15",
            "Value": "jetstreamdeviceurl"
        },
        {
            "Key": "Parameter16",
            "Value": "lockdownhightemp"
        },
        {
            "Key": "Parameter17",
            "Value": "lockdownonacpowerfailure"
        },
        {
            "Key": "Parameter18",
            "Value": "lockdownonhightemp"
        },
        {
            "Key": "Parameter19",
            "Value": "lockdownonreaderfailure"
        },
        {
            "Key": "Parameter20",
            "Value": "logentryeventhightemp"
        },
        {
            "Key": "Parameter21",
            "Value": "logentryeventlowtemp"
        },
        {
            "Key": "Parameter22",
            "Value": "logentrylevel"
        },
        {
            "Key": "Parameter23",
            "Value": "numberofantennas"
        },
        {
            "Key": "Parameter24",
            "Value": "objecteventscancount"
        },
        {
            "Key": "Parameter25",
            "Value": "objecteventscantime"
        },
        {
            "Key": "Parameter26",
            "Value": "subnet"
        }
    ],
    "Type": "CommandQueuedEvent",
    "EventId": "fe971dbc-a783-458c-9096-ea2869956fae",
    "EventTime": "2017-05-18T20:55:09Z",
    "Version": 3
}

Published CommandQueuedEvent for Set a Device’s Configuration Parameters

{
    "Device": "MyDeviceName",
    "CommandId": "2bf00848-b06a-4820-86fc-58c12e08ee3e",
    "CommandName": "SetConfigValuesCommand",
    "URI": "/3/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",
    "Version": 3
}
Replaced CommandQueuedEvents for Get All Passes, Add and/or Remove Passes, and Replace All Passes with the CommandQueuedEvent for Sync Device Credentials.
Removed CommandQueuedEvent for Update Agent Firmware.
Addition of the Version property.