REST API Test Page

Operation

POST on /triggers/test

Test a setup trigger definition, executing its effects : see asset-specs for scheduling Intervals composition (exhaustive but non-functional example)

Produces : application/json

Parameters

Name	Type	Value	Description
(JSON)	Request Body	{ "ifThenSetupTrigger" : { "label" : "an if then setup trigger label", "serverSide" : true, "mode" : 1, "schedulingIntervals" : [ { "weeklySchedule" : { "startMinutes" : 9, "stopMinutes" : 15, "startOffset" : 14, "stopOffset" : 12, "startAngle" : 8, "stopAngle" : 13, "startType" : "DUSK", "stopType" : "DAWN", "startAlwaysBefore" : "07:50", "stopAlwaysBefore" : "23:50", "startAlwaysAfter" : "06:50", "stopAlwaysAfter" : "21:50", "startDay" : 2, "stopDay" : 6 } } ], "allowExecuteOnEnabled" : false, "metadata" : "some metadata", "allowFromUnknownValue" : true, "rootConditionBlock" : { "orBlock" : { "activationDelay" : 1, "deactivationDelay" : 4, "subConditionBlocks" : [ { "staticDeviceStateCondition" : { "activationDelay" : 1, "deactivationDelay" : 7, "stateName" : "a state name", "operator" : "BETWEEN_INCLUSIVE", "value1" : "a value1", "value2" : "a value2", "objectPath" : "an object path", "type" : "EVENT_BASED", "deviceURL" : "<protocol>://<gatewayId>/<deviceAddress>" } } ] } }, "effects" : [ { "actionGroupEffect" : { "actionGroupOID" : "an action group OID", "localActionGroup" : { "label" : "a managed action group label", "metadata" : "some metadata", "shortcut" : false, "notificationTypeMask" : 1, "notificationCondition" : "ON_SUCCESS", "notificationText" : "a notification text", "notificationTitle" : "a notification title", "targetEmailAddresses" : [ "some target email addresses" ], "targetPhoneNumbers" : [ "some target phone numbers" ], "targetPushSubscriptions" : [ "some target push subscriptions" ], "actions" : [ { "deviceURL" : "device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])", "commands" : [ { "type" : 1, "name" : "a command name", "parameters" : [ "some parameters" ], "sensitiveParametersIndexes" : [ 1 ], "authentication" : "an authentication", "delay" : 1, "lockLevel" : 20 } ] } ] } } } ], "usingTriggerModeFlag" : false } }*	Json description of the setup trigger to test

Result

HTTP Status :