trigger.event.list
The trigger.event.list command is used to list all trigger event types with their inputs and outputs.
TR50 Request
{
"cmd": {
"command": "trigger.event.list"
}
}
TR50 Response
If the command is sent successfully a success message is returned. Otherwise, an error and error message will be returned.
{
"cmd": {
"success": true,
"params": {
"result": [
{
"inputs": [
{
"key": "thingKey",
"name": "Thing Key",
"required": false,
"type": "thingkey"
},
{
"count": 10,
"key": "thingTags",
"name": "Thing Tags",
"required": false,
"type": "tags"
},
{
"key": "alarmKey",
"name": "Alarm Key",
"required": false,
"type": "string"
},
{
"key": "alarmState",
"name": "Alarm State",
"required": false,
"type": "number"
},
{
"key": "timeInCond",
"name": "Time in Condition (seconds)",
"required": false,
"type": "number"
}
],
"outputs": [
{
"key": "thing.key",
"name": "Thing Key",
"type": "string"
},
{
"key": "thing.name",
"name": "Thing Name",
"type": "string"
},
{
"key": "thing.type",
"name": "Thing Type",
"type": "string"
},
{
"key": "alarm.key",
"name": "Alarm Key",
"type": "string"
},
{
"key": "alarm.name",
"name": "Alarm Name",
"type": "string"
},
{
"key": "alarm.state",
"name": "Alarm State",
"type": "number"
},
{
"key": "alarm.string",
"name": "Alarm String",
"type": "string"
},
{
"key": "alarm.msg",
"name": "Alarm Message",
"type": "string"
},
{
"key": "alarm.ts",
"name": "Timestamp",
"type": "timestamp"
},
{
"key": "alarm.corrId",
"name": "Correlation Id",
"type": "string"
}
],
"type": "alarm.change"
},
{
"inputs": [
{
"key": "thingKey",
"name": "Thing Key",
"type": "thingkey"
},
{
"count": 10,
"key": "thingTags",
"name": "Thing Tags",
"type": "tags"
}
],
"outputs": [
{
"key": "thing.key",
"name": "Thing Key",
"type": "string"
},
{
"key": "thing.name",
"name": "Thing Name",
"type": "string"
},
{
"key": "thing.type",
"name": "Thing Type",
"type": "string"
},
{
"key": "location.lat",
"name": "Latitude",
"type": "number"
},
{
"key": "location.lng",
"name": "Longitude",
"type": "number"
},
{
"key": "location.heading",
"name": "Heading",
"type": "number"
},
{
"key": "location.speed",
"name": "Speed",
"type": "number"
},
{
"key": "location.ts",
"name": "Timestamp",
"type": "timestamp"
},
{
"key": "location.corrId",
"name": "Correlation Id",
"type": "string"
},
{
"key": "location.streetNumber",
"name": "Street Number",
"type": "string"
},
{
"key": "location.street",
"name": "Street",
"type": "string"
},
{
"key": "location.city",
"name": "City",
"type": "string"
},
{
"key": "location.state",
"name": "State",
"type": "string"
},
{
"key": "location.zipCode",
"name": "Zip Code",
"type": "string"
},
{
"key": "location.country",
"name": "Country",
"type": "string"
}
],
"type": "location.change"
},
{
"inputs": [
{
"key": "thingKey",
"name": "Thing Key",
"required": false,
"type": "thingkey"
},
{
"count": 10,
"key": "thingTags",
"name": "Thing Tags",
"required": false,
"type": "tags"
},
{
"key": "propKey",
"name": "Property Key",
"required": false,
"type": "string"
},
{
"key": "operator",
"name": "Operator",
"options": [
[
"always",
"Always execute"
],
[
"lt",
"Value < Operand"
],
[
"lte",
"Value <= Operand"
],
[
"eq",
"Value == Operand"
],
[
"neq",
"Value != Operand"
],
[
"gte",
"Value >= Operand"
],
[
"gt",
"Value > Operand"
],
[
"between",
"Operand1 <= Value < Operand2"
]
],
"required": true,
"type": "dropdown"
},
{
"key": "operand",
"name": "Operand",
"required": false,
"type": "string"
},
{
"key": "timeInCond",
"name": "Time in Condition (seconds)",
"required": false,
"type": "number"
}
],
"outputs": [
{
"key": "thing.key",
"name": "Thing Key",
"type": "string"
},
{
"key": "thing.name",
"name": "Thing Name",
"type": "string"
},
{
"key": "thing.type",
"name": "Thing Type",
"type": "string"
},
{
"key": "prop.key",
"name": "Property Key",
"type": "string"
},
{
"key": "prop.name",
"name": "Property Name",
"type": "string"
},
{
"key": "prop.unit",
"name": "Property Unit",
"type": "string"
},
{
"key": "prop.value",
"name": "Property Value",
"type": "number"
},
{
"key": "prop.ts",
"name": "Timestamp",
"type": "timestamp"
},
{
"key": "prop.corrId",
"name": "Correlation Id",
"type": "string"
},
{
"key": "prev.value",
"name": "Previous Value",
"type": "number"
},
{
"key": "prev.ts",
"name": "Previous Timestamp",
"type": "timestamp"
}
],
"type": "property.change"
},
{
"inputs": [
{
"key": "geofenceEvent",
"name": "Geofence Event",
"options": [
[
"enter",
"Enter"
],
[
"leave",
"Leave"
]
],
"required": true,
"type": "dropdown"
},
{
"key": "geofenceKey",
"name": "Geofence Key",
"required": false,
"type": "string"
},
{
"key": "thingKey",
"name": "Thing Key",
"required": false,
"type": "thingkey"
},
{
"count": 10,
"key": "thingTags",
"name": "Thing Tags",
"required": false,
"type": "tags"
}
],
"outputs": [
{
"key": "geofence.key",
"name": "Geofence Key",
"type": "string"
},
{
"key": "geofence.name",
"name": "Geofence Name",
"type": "string"
},
{
"key": "thing.key",
"name": "Thing Key",
"type": "string"
},
{
"key": "thing.name",
"name": "Thing Name",
"type": "string"
},
{
"key": "location.lat",
"name": "Property Key",
"type": "string"
},
{
"key": "location.lng",
"name": "Property Value",
"type": "number"
},
{
"key": "location.ts",
"name": "Timestamp",
"type": "timestamp"
}
],
"type": "geofence"
},
{
"inputs": [
{
"key": "status",
"name": "Status",
"options": [
[
"activated",
"Activated"
],
[
"deactivated",
"Deactivated"
],
[
"inventory",
"Inventory"
],
[
"ready",
"Ready"
],
[
"retired",
"Retired"
],
[
"testing",
"Testing"
]
],
"required": false,
"type": "dropdown"
},
{
"key": "requireThing",
"name": "Require thing exists",
"options": [
[
"false",
"False"
],
[
"true",
"True"
]
],
"required": true,
"type": "dropdown"
},
{
"count": 10,
"key": "connTags",
"name": "Connection tags",
"required": false,
"type": "tags"
}
],
"outputs": [
{
"key": "conn.iccid",
"name": "ICCID",
"type": "string"
},
{
"key": "conn.meid",
"name": "MEID",
"type": "string"
},
{
"key": "conn.imei",
"name": "IMEI",
"type": "string"
},
{
"key": "conn.imsi",
"name": "IMSI",
"type": "string"
},
{
"key": "status",
"name": "Status",
"type": "string"
},
{
"key": "prevStatus",
"name": "Previous Status",
"type": "string"
},
{
"key": "ts",
"name": "Timestamp",
"type": "timestamp"
},
{
"key": "thing.key",
"name": "Thing key",
"type": "string"
},
{
"key": "thing.name",
"name": "Thing name",
"type": "string"
}
],
"type": "connection.status.change"
},
]
}
}
}
Response Parameters
|
Name |
Type |
Description |
|---|---|---|
|
result |
Array |
An array consisting of result objects. |
Result Object
|
Name |
Type |
Description |
|---|---|---|
|
type |
String |
The event type. |
|
inputs |
Array |
Array of objects describing input parameters for this event type. |
|
outputs |
Array |
Array of objects describing output parameters for this event type. |
Input/Output Object
|
Name |
Type |
Description |
|---|---|---|
|
key |
String |
The input parameter field key. |
|
name |
String |
The name of this input. |
|
options |
Array |
The event options |
|
required |
Boolean |
Whether this parameter is required. |
|
type |
String |
The type of this input's value. |
|
count |
Boolean |
If multiple values are possible, the maximum array size. |