REST API Test Page
Operation
POST
on
/setup/calendar/rules
Create a calendar rule.
Produces
: application/json
Parameters
Name
Type
Value
Description
(JSON)
Request Body
{ "weeklyCalendarRule" : { "priority" : 1, "calendarDayOID" : "a calendar day OID", "finalRule" : true, "randomTimeRange" : 1, "dayType" : "HOLIDAY", "enabled" : false, "metadata" : "some metadata", "startTimeHours" : 1, "startTimeMinutes" : 1, "endTimeHours" : 1, "endTimeMinutes" : 1, "localCalendarDay" : { "label" : "a calendar day label", "type" : "DAY_OFF_AT_HOME", "dayTimeTriggers" : [ { "startActionGroupTimeTrigger" : { "triggerType" : "DUSK", "minutes" : 1, "hours" : 1, "metadata" : "some metadata", "enabled" : true, "duskOffset" : 1, "dawnOffset" : 1, "randomTimeOffset" : 9, "alwaysBeforeHours" : 6, "alwaysBeforeMinutes" : 8, "alwaysAfterHours" : 5, "alwaysAfterMinutes" : 10, "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" : 14 } ] } ] } } } ], "metadata" : "some metadata" }, "startYear" : 1, "startMonth" : 1, "startDay" : 1, "endYear" : 1, "endMonth" : 1, "endDay" : 1, "period" : 1, "presenceFilter" : "NO_FILTER", "dayMask" : 1 } }
*
Json description of the calendar rule to create
withTimeValidityChecks
Request Parameter
Result
HTTP Status :