thing.find action

This trigger action will find a thing.

Action

This trigger action is found under the Thing heading.

Canvas

When dragged onto the canvas, the appearance of the action is a rectangle with two routing points.

The left routing point (red) is the failure route. This route will be taken if there is an error during execution.

The right routing point (green) is the success route. This route will be taken if action executes successfully.

Form

Parameters

Name Type Required Description

id

String Yes* The id of the thing.
esn String ESN of the connection.
iccid String ICCID of the connection.
imei String IMEI of the connection.
imsi String IMSI of the connection.
meid String MEID of the connection.
msisdn String MSISDN of the connection.
thingKey String The identifier of the thing that the connection is related to.
thingId String The identifier of the thing that the connection is related to.
*One of the above parameters is required to identify the connection.
Load Values Boolean   By default it is set to False. If you set it to True, the thing.find trigger action will return alarms, attributes, and properties. For example: When Load Values is set to True, it returns: 
{
....
"alarms": {
	"alarm1": {
	  "msg": "My alarm message.",
	  "since": "2019-04-01T18:18:29.008Z",
	  "state": 1,
	  "ts": "2019-04-01T18:18:29.008Z"
	}
 },									
  "attrs" : {
	"attr1": {
	"since": "2019-04-01T18:16:33.752Z",
	"ts": "2019-04-01T18:16:33.752Z",
	"value": "myvalue"
    }
  },

"properties": {
  "prop1": {
	"ts": "2019-04-01T18:13:07.565Z",
	"value": 1.2345
	}
},
....
}

If the Thing is a LoRa device or a LwM2M device, setting the Load Values parameter to true will return the Lora or LwM2M device details under the relevant key and the related values will also be available.

Action variable

Name Type Description
$(action.X.<field>)1 Array A field from the thing data structure.

EXAMPLE:

To access data within the Thing structure, you would construct the path to the data and replace <field> with that path. For example, to access the key of a Thing, replace <field> with name: $(action.X.key).

  • $(action.2.name)
    • 2 is the index of the action being referenced
    • name is the element of the Thing structure to be used
  • $(action.1.properties.propertyKey.value)
    • 1 is the index of the action being referenced
    • properties are the thing's property substructure
    • propertyKey is the key to the property
    • value is the value of the property to be used
  • $(action.0.loc.speed)
    • 0 is the index of the action being referenced
    • loc is the thing's location substructure
    • speed is the element within the location substructure to be used
  • $(action.3.apiCounts.monthToDate)
    • 3 is the index of the action being referenced
    • apiCounts is the Thing's apiCount substructure
    • monthToDate is the element within the apiCount substructure to be used