trigger.template.list

The trigger.template.list command is used to find and return a list of trigger templates.

TR50 Request


                        {
  "1": {
    "command": "trigger.template.list"
  }
}
      

Request Parameters

Name

Type

Required

Description

offset

Integer

 

The starting list offset, used for pagination. Defaults to 0 if not specified.

limit

Integer

 

Limit the number of results returned. Defaults to the configured maximum limit.

TR50 Response

If the command is sent successfully a success message is returned. Otherwise, an error and error message will be returned.


                        {
  "1": {
    "success": true,
    "params": {
      "result": [
        {
          "id": "53728d6b31004662fe000052",
          "name": "Get SMS",
          "desc": "Gets an SMS",
          "started": false,
          "eventType": "twilio.sms.receive",
          "successCount": 4,
          "lastSuccess": "2014-05-14T15:30:14.551Z",
          "failureCount": 0,
          "lastFailure": "0001-01-01T00:00:00Z",
          "createdBy": "jhughes@example.com",
          "createdOn": "2014-05-13T21:23:55.561Z",
          "updatedBy": "admin@example.com",
          "updatedOn": "2014-06-06T19:27:04.136Z"
        },
        {
          "id": "5391cf323100465ec1000087",
          "name": "Turn on Heater when Cold",
          "started": false,
          "eventType": "property.change",
          "successCount": 4,
          "lastSuccess": "2014-06-11T09:00:45.038Z",
          "failureCount": 0,
          "lastFailure": "0001-01-01T00:00:00Z",
          "createdBy": "jwert@example.com",
          "createdOn": "2014-06-06T14:24:50.984Z",
          "updatedBy": "jwert-fa@example.com",
          "updatedOn": "2014-06-11T12:49:46.064Z"
        }
      ]
    }
  }
}
      

Response Parameters

Name

Type

Description

result

Array

An array consisting of result objects.

Result Object

Name

Type

Description

id

String

The unique identifier of the trigger.

name

String

The name of the trigger.

desc

String

The description of the trigger.

started

Boolean

Whether the trigger has been started.

eventType

String

The trigger event type.

successCount

Integer

Number of times the trigger has been successfully executed.

lastSuccess

String

Timestamp of the last successful execution associated with this trigger.

failureCount

Integer

Number of times the trigger has failed during execution.

lastFailure

String

Timestamp of the last failed execution associated with this trigger.

createdBy

String

 The creator of this trigger.

createdOn

String

The creation timestamp of this trigger.

updatedBy

String

The updater of this trigger.

updatedOn

String

The update timestamp of this trigger.