Property | Type | Description | Mandatory |
|---|---|---|---|
name | String | A free-text name for the Rule. This name can be included in the message that is sent. | Y |
description | String | A free-text description of the Rule. | |
active | Boolean | Specifies whether the Rule is active, meaning that it can be used – True/False. | Y |
severity | String | Specifies the severity of the event that triggered this Rule. Typically, this is used when the Rule triggers an AlarmInstance and may have one of the following values – • Critical • Warning • Major • Minor | Y |
cronSchedule | String | Specifies the CRON schedule when this Rule is triggered. If this field contains a CRON schedule, then no other conditions in this Rule are relevant, including the schedule property. “cronSchedule” : “00 12 * * *”, This property is typically used to report periodic information from a Device, such as its status (ON/OFF). This option is only relevant if the TimeBased option is specified in the type property (described below). | |
type | String/ Enum | Two kinds of Rules are provided as specified by the value in this property – • TimeBased – This Rule is automatically triggered according to the schedule defined in the cronSchedule property (described above). • Conditional – Specifies that this Rule is triggered when the readings of a Device match the conditions defined in the conditions property of this Rule. | |
timezone | String | The default timezone of the Rule. “timezone”:”Asia/Jerusalem” | |
category | String | The type of entity on which the action (described above) is performed, such as a Device, Application or Product. | |
level | For internal use. | ||
automaticallyDismiss | Boolean | If true, when the Rule restores, then all the AlarmInstances that were created by this Rule and are still open are all automatically closed. | |
relativeMeetingSchedule | RelativeMeetingSchedule | Specify trigger by meeting. | |
notifyOnRestore | Boolean | If True, then when the Rule restores, a notification is automatically sent, according to the SMS (smsProperties), email (emailProperties) or phone call (phoneCallProperties) properties defined for this Rule, as described below. | |
tenantId | This field is automatically filled by the IoT Platform Server, and there is no need to fill it in. | ||
appId | A unique Application identifier that is automatically generated by IoT Platform . This is the identifier of the Application to which this Rule is assigned. This identifier is automatically added by IoT Platform when the Applications/Post request is used. | ||
restoreActions | Array | These are the actions that are executed after a Restore event occurs. A restore event occurs and the rule is triggered when both of the following happen – • After the conditions of a Rule have been met. – And – • After the Rule’s conditions cease to be met, meaning that the previous conditions have been restored. For example, if the condition of the Rule is that the temperature is over 20°, then the Restore actions are triggered after the temperature has gone over 20° (which triggers the Rule) and then goes below 20° (which triggers the Restore event). | |
schedule (Deprecated) See weeklySchedule | Object | Deprecated Specifies the day and time of day when the Rule is active (meaning that the Rule can be triggered if the other conditions are met). True indicates that the Rule is active for the specified day during the time range (times) specified by startTime and endTime. “schedule” : { “sun” : true, “mon” : false, “tue” : false, “wed” : false, “thu” : false, “fri” : false, “sat” : false, “times” : { } Note ‒ If the startTime is later than the endTime, the clock schedules from the end time to the start time. For example, a startTime of 19:00 and an endTime of 23:00 represents the period from 7:00–11:00 pm. A startTime of 23:00 and an endTime of 7:00 represents the period from 11:00 pm of one day until 07:00AM the following day. | |
weeklySchedule | Object | Defines the time range in which the Rule is active for each day of the week. The timeRange property defines when the Rule is active on a specific day. Each timeRange has the following format – Null or [“startTime” : “19:17”, “endTime” : “23:17”] “weeklySchedule”: { “sun”: { “active”: true, “timeRange”:[“startTime” : “19:17”, “endTime” : “23:17”] }, “mon”: { “active”: true, “timeRange”: null }, “tue”: { “active”: true, “timeRange”: null }, “wed”: { “active”: true, “timeRange”: null }, “thu”: { “active”: true, “timeRange”: null }, “fri”: { “active”: true, “timeRange”: null }, “sat”: { “active”: true, “timeRange”: null } Note ‒ If the startTime is later than the endTime, the clock schedules from the end time to the start time. For example, a startTime of 19:00 and an endTime of 23:00 represents the period from 7:00–11:00 pm. A startTime of 23:00 and an endTime of 7:00 represents the period from 11:00 pm of one day until 07:00AM the following day. |