--- title: "PATCH /lprAlertConditionRules/{id}" method: PATCH path: "/lprAlertConditionRules/{id}" tags: ["LPR Rules"] --- # PATCH /lprAlertConditionRules/{id} `PATCH /lprAlertConditionRules/{id}` Updates the properties of a specific rule. Only the user defined fields can be updated by this method. ## Path parameters - `id` string, required ## Request body - union - LprAlertConditionRuleAccessControlForPatch — Encompasses all the user specified properties of a rule used to generate alerts. - `name` string — Meaningful name for the rule - `priority` integer — Defines the priority of the alert - `notes` string — A verbose explanation of the rule - `enabled` boolean — Whether rule is enabled - `configuration` union - object — Configuration parameters for access control Rule Behavior - `barrierOpen` boolean, required — A flag that indicates whether to open boom barrier / vending gate, if any associated. This rule property may be interpreted by any LPR algorithm that runs for the cameras/locations/account to which this rule applies. - `filterType` 'plate', required — Enumerates available filter types. The brief synopsis of the filters is as follows: * plate: rule is applied to one or more plate(s) * vehicleList: rule is applied to one or more vehicle list(s) * anyPlateExcept: rule to be applied to all plates, except ones which are exempted in the optionally provided vehicle list - `plates` string[], required — Specific license plates on which the rule fires. This can be used to map specific plates to a rule, without the need to add them to a vehicle list. - object — Configuration parameters for access control Rule Behavior - `barrierOpen` boolean, required — A flag that indicates whether to open boom barrier / vending gate, if any associated. This rule property may be interpreted by any LPR algorithm that runs for the cameras/locations/account to which this rule applies. - `filterType` 'vehicleList', required — Enumerates available filter types. The brief synopsis of the filters is as follows: * plate: rule is applied to one or more plate(s) * vehicleList: rule is applied to one or more vehicle list(s) * anyPlateExcept: rule to be applied to all plates, except ones which are exempted in the optionally provided vehicle list - `vehicleListIds` string[], required — Enumerates the IDs of all Vehicle Lists that are under the purview of this rule. - object — Configuration parameters for access control Rule Behavior - `barrierOpen` boolean, required — A flag that indicates whether to open boom barrier / vending gate, if any associated. This rule property may be interpreted by any LPR algorithm that runs for the cameras/locations/account to which this rule applies. - `filterType` 'anyPlateExcept', required — Enumerates available filter types. The brief synopsis of the filters is as follows: * plate: rule is applied to one or more plate(s) * vehicleList: rule is applied to one or more vehicle list(s) * anyPlateExcept: rule to be applied to all plates, except ones which are exempted in the optionally provided vehicle list - `exemptionVehicleListIds` string[], required — Enumerates the IDs of all Vehicle Lists that are used for exemption of vehicles from the rule. - `type` 'lprRuleAccessControlAllow' | 'lprRuleAccessControlDeny' — Rules of type `lprRuleAccessControlAllow` and `lprRuleAccessControlDeny` create an alert when vehicles are seen whose access type is `allow` or `deny` respectively. - `eventFilter` EventFilterForPatch — A list of attributes of the event used to funnel down a specific set of events for any downstream action. This filtering construct is as such independent of VSP and quite generic - `eventTypes` string[] — List of event types allowed to be processed by this rule - `schedule` WeeklyIntervalSchedule — It signifies a week long alert schedule. This schedule is effective according to actor's (user/camera/account) timezone. It allows setting different times for different days. - `sunday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `monday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `tuesday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `wednesday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `thursday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `friday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `saturday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `resourceFilter` ResourceFilter — List of actors against which filtering to happen (camera/location/account) - `actors` ActorFilter[] — List of the actors for which events are checked. - `id` string — The id of the thing that caused the event This can be camera or location ID. If not supplied for any entry in the array, it is taken to mean as the entire account. - `type` 'camera' | 'location', required — Type of actor that caused the event. - LprAlertConditionRuleEventAggrForPatch — Encompasses all the user specified properties of a rule used to generate alerts. - `name` string — Meaningful name for the rule - `priority` integer — Defines the priority of the alert - `notes` string — A verbose explanation of the rule - `enabled` boolean — Whether rule is enabled - `configuration` object — Configuration Parameters pertaining to Event Aggregation Rule. This rule checks for the count vehicle events in a window of specified size, for any camera under the purview of this rule. It fires on this count being either above or below this threshold, as specified by the configuration parameters. In other words, the rule can be used for checking either too many or too few events in a given time window. - `windowSize` string, required — Window size of event aggregation. For example, if set to 1h, then the rule is applied on every sliding window of duration 1 hour. - `countThr` integer, required — Count of vehicle threshold for alert - `greaterThanThr` boolean, required — If true, alert fires on count > threshold, else it fires on below thr - `type` 'lprRuleCountAggr' — Rule of type `lprRuleCountAggr` sets up aggregation for camera or location and fires an alert if the aggregation (detection count) in a specified time interval falls above or below threshold. - `eventFilter` EventFilterForPatch — A list of attributes of the event used to funnel down a specific set of events for any downstream action. This filtering construct is as such independent of VSP and quite generic - `eventTypes` string[] — List of event types allowed to be processed by this rule - `schedule` WeeklyIntervalSchedule — It signifies a week long alert schedule. This schedule is effective according to actor's (user/camera/account) timezone. It allows setting different times for different days. - `sunday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `monday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `tuesday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `wednesday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `thursday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `friday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `saturday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `resourceFilter` ResourceFilter — List of actors against which filtering to happen (camera/location/account) - `actors` ActorFilter[] — List of the actors for which events are checked. - `id` string — The id of the thing that caused the event This can be camera or location ID. If not supplied for any entry in the array, it is taken to mean as the entire account. - `type` 'camera' | 'location', required — Type of actor that caused the event. - LprAlertConditionRuleWatchForPatch — Encompasses all the user specified properties of a rule used to generate alerts. - `name` string — Meaningful name for the rule - `priority` integer — Defines the priority of the alert - `notes` string — A verbose explanation of the rule - `enabled` boolean — Whether rule is enabled - `configuration` union - object — Configuration parameters for the Vehicle Watch rule - `durationThresh` string, required — Time threshold within which the same vehicle (same license plate) must be seen again. Acceptable range: between 5 minutes (5m) and 24 hours (24h). - `originActors` object[], required - `id` string — The id of the thing that caused the event This can be camera or location ID. - `type` 'camera' | 'location', required — Type of actor that caused the event. - `destinationActors` object[], required - `id` string — The id of the thing that caused the event This can be camera or location ID. - `type` 'camera' | 'location', required — Type of actor that caused the event. - `filterType` 'plate', required — Enumerates available filter types. The brief synopsis of the maps as follows: * plate: rule should be applied to one or more plate(s) * vehicleList: rule to be applied to one or more vehicle list(s) * anyPlateExcept: rule to be applied to all plates, except ones which are exempted in the optionally provided vehicle list - `plates` string[], required — Specific license plates on which the rule fires. This can be used to map specific plates to a rule, without the need to add them to a vehicle list. - object — Configuration parameters for the Vehicle Watch rule - `durationThresh` string, required — Time threshold within which the same vehicle (same license plate) must be seen again. Acceptable range: between 5 minutes (5m) and 24 hours (24h). - `originActors` object[], required - `id` string — The id of the thing that caused the event This can be camera or location ID. - `type` 'camera' | 'location', required — Type of actor that caused the event. - `destinationActors` object[], required - `id` string — The id of the thing that caused the event This can be camera or location ID. - `type` 'camera' | 'location', required — Type of actor that caused the event. - `filterType` 'vehicleList', required — Enumerates available filter types. The brief synopsis of the maps as follows: * plate: rule should be applied to one or more plate(s) * vehicleList: rule to be applied to one or more vehicle list(s) * anyPlateExcept: rule to be applied to all plates, except ones which are exempted in the optionally provided vehicle list - `vehicleListIds` string[], required — Enumerates the IDs of all Vehicle Lists that are under the purview of this rule. - object — Configuration parameters for the Vehicle Watch rule - `durationThresh` string, required — Time threshold within which the same vehicle (same license plate) must be seen again. Acceptable range: between 5 minutes (5m) and 24 hours (24h). - `originActors` object[], required - `id` string — The id of the thing that caused the event This can be camera or location ID. - `type` 'camera' | 'location', required — Type of actor that caused the event. - `destinationActors` object[], required - `id` string — The id of the thing that caused the event This can be camera or location ID. - `type` 'camera' | 'location', required — Type of actor that caused the event. - `filterType` 'anyPlateExcept', required — Enumerates available filter types. The brief synopsis of the maps as follows: * plate: rule should be applied to one or more plate(s) * vehicleList: rule to be applied to one or more vehicle list(s) * anyPlateExcept: rule to be applied to all plates, except ones which are exempted in the optionally provided vehicle list - `exemptionVehicleListIds` string[], required — Enumerates the IDs of all Vehicle Lists that are used for exemption of vehicles from the rule. - `type` 'lprRuleWatch' — Rule of type `lprRuleWatch` raises an alert if a vehicle is seen once and is not seen again within the specified time interval. - `eventFilter` EventFilterForPatch — A list of attributes of the event used to funnel down a specific set of events for any downstream action. This filtering construct is as such independent of VSP and quite generic - `eventTypes` string[] — List of event types allowed to be processed by this rule - `schedule` WeeklyIntervalSchedule — It signifies a week long alert schedule. This schedule is effective according to actor's (user/camera/account) timezone. It allows setting different times for different days. - `sunday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `monday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `tuesday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `wednesday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `thursday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `friday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `saturday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `resourceFilter` ResourceFilter — List of actors against which filtering to happen (camera/location/account) - `actors` ActorFilter[] — List of the actors for which events are checked. - `id` string — The id of the thing that caused the event This can be camera or location ID. If not supplied for any entry in the array, it is taken to mean as the entire account. - `type` 'camera' | 'location', required — Type of actor that caused the event. - LprAlertConditionRuleHotlistForPatch — Encompasses all the user specified properties of a rule used to generate alerts. - `name` string — Meaningful name for the rule - `priority` integer — Defines the priority of the alert - `notes` string — A verbose explanation of the rule - `enabled` boolean — Whether rule is enabled - `configuration` union - object — Configuration parameters for the Vehicle hotlist rule - `filterType` 'plate', required — Enumerates available filter types. The brief synopsis of the maps as follows: * plate: rule should be applied to one or more plate(s) * vehicleList: rule to be applied to one or more vehicle list(s) * anyPlateExcept: rule to be applied to all plates, except ones which are exempted in the optionally provided vehicle list - `plates` string[], required — Specific license plates on which the rule fires. This can be used to map specific plates to a rule, without the need to add them to a vehicle list. - object — Configuration parameters for the Vehicle hotlist rule - `filterType` 'vehicleList', required — Enumerates available filter types. The brief synopsis of the maps as follows: * plate: rule should be applied to one or more plate(s) * vehicleList: rule to be applied to one or more vehicle list(s) * anyPlateExcept: rule to be applied to all plates, except ones which are exempted in the optionally provided vehicle list - `vehicleListIds` string[], required — Enumerates the IDs of all Vehicle Lists that are under the purview of this rule. - object — Configuration parameters for the Vehicle hotlist rule - `filterType` 'anyPlateExcept', required — Enumerates available filter types. The brief synopsis of the maps as follows: * plate: rule should be applied to one or more plate(s) * vehicleList: rule to be applied to one or more vehicle list(s) * anyPlateExcept: rule to be applied to all plates, except ones which are exempted in the optionally provided vehicle list - `exemptionVehicleListIds` string[], required — Enumerates the IDs of all Vehicle Lists that are used for exemption of vehicles from the rule. - `type` 'lprRuleHotlist' — A rule of type `lprRuleHotlist` triggers an alert when either: 1. A specific license plate is detected. 2. A license plate from a vehicle list is detected. - `eventFilter` EventFilterForPatch — A list of attributes of the event used to funnel down a specific set of events for any downstream action. This filtering construct is as such independent of VSP and quite generic - `eventTypes` string[] — List of event types allowed to be processed by this rule - `schedule` WeeklyIntervalSchedule — It signifies a week long alert schedule. This schedule is effective according to actor's (user/camera/account) timezone. It allows setting different times for different days. - `sunday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `monday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `tuesday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `wednesday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `thursday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `friday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `saturday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `resourceFilter` ResourceFilter — List of actors against which filtering to happen (camera/location/account) - `actors` ActorFilter[] — List of the actors for which events are checked. - `id` string — The id of the thing that caused the event This can be camera or location ID. If not supplied for any entry in the array, it is taken to mean as the entire account. - `type` 'camera' | 'location', required — Type of actor that caused the event. - LprAlertConditionRuleUnlistedForPatch — Encompasses all the user specified properties of a rule used to generate alerts. - `name` string — Meaningful name for the rule - `priority` integer — Defines the priority of the alert - `notes` string — A verbose explanation of the rule - `enabled` boolean — Whether rule is enabled - `configuration` object — Configuration parameters for the Unlisted vehicle rule - `filterType` 'vehicleList', required — Specify the filter type for the rule, currently only vehicleList is supported: * vehicleList: rule to be applied to one or more vehicle list(s) - `vehicleListIds` string[], required — Enumerates the IDs of all Vehicle Lists that are under the purview of this rule. - `type` 'lprRuleUnlisted' — A rule of type `lprRuleUnlisted` triggers an alert when a license plate is detected that does not appear in the configured vehicle list. - `eventFilter` EventFilterForPatch — A list of attributes of the event used to funnel down a specific set of events for any downstream action. This filtering construct is as such independent of VSP and quite generic - `eventTypes` string[] — List of event types allowed to be processed by this rule - `schedule` WeeklyIntervalSchedule — It signifies a week long alert schedule. This schedule is effective according to actor's (user/camera/account) timezone. It allows setting different times for different days. - `sunday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `monday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `tuesday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `wednesday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `thursday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `friday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `saturday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `resourceFilter` ResourceFilter — List of actors against which filtering to happen (camera/location/account) - `actors` ActorFilter[] — List of the actors for which events are checked. - `id` string — The id of the thing that caused the event This can be camera or location ID. If not supplied for any entry in the array, it is taken to mean as the entire account. - `type` 'camera' | 'location', required — Type of actor that caused the event. - LprAlertConditionRuleWrongDirectionForPatch — Encompasses all the user specified properties of a rule used to generate alerts. - `name` string — Meaningful name for the rule - `priority` integer — Defines the priority of the alert - `notes` string — A verbose explanation of the rule - `enabled` boolean — Whether rule is enabled - `configuration` object - `filterType` 'allPlates', required - `type` 'lprRuleWrongDirection' — A rule of type `lprRuleWrongDirection` triggers an alert when a vehicle is detected traveling in the wrong direction. - `eventFilter` EventFilterForPatch — A list of attributes of the event used to funnel down a specific set of events for any downstream action. This filtering construct is as such independent of VSP and quite generic - `eventTypes` string[] — List of event types allowed to be processed by this rule - `schedule` WeeklyIntervalSchedule — It signifies a week long alert schedule. This schedule is effective according to actor's (user/camera/account) timezone. It allows setting different times for different days. - `sunday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `monday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `tuesday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `wednesday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `thursday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `friday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `saturday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `resourceFilter` ResourceFilter — List of actors against which filtering to happen (camera/location/account) - `actors` ActorFilter[] — List of the actors for which events are checked. - `id` string — The id of the thing that caused the event This can be camera or location ID. If not supplied for any entry in the array, it is taken to mean as the entire account. - `type` 'camera' | 'location', required — Type of actor that caused the event. - LprAlertConditionRuleOverstayForPatch — Encompasses all the user specified properties of a rule used to generate alerts. - `name` string — Meaningful name for the rule - `priority` integer — Defines the priority of the alert - `notes` string — A verbose explanation of the rule - `enabled` boolean — Whether rule is enabled - `configuration` union - object — Configuration parameters for the Overstay rule - `alertTime` string, required — Daily clock time in 24-hour "HH:MM" format. When a vehicle entry is detected, an alert is scheduled for the next occurrence of this time. If the vehicle has not exited by then, the alert fires. - `filterType` 'plate', required — Enumerates available filter types: * plate: rule should be applied to a specific plate * vehicleList: rule to be applied to a specific vehicle list * anyPlateExcept: rule to be applied to all plates, except ones exempted in the provided vehicle list * allPlates: rule to be applied to all plates - `plates` string[], required — Specific license plates on which the rule fires. This can be used to map specific plates to a rule, without the need to add them to a vehicle list. - object — Configuration parameters for the Overstay rule - `alertTime` string, required — Daily clock time in 24-hour "HH:MM" format. When a vehicle entry is detected, an alert is scheduled for the next occurrence of this time. If the vehicle has not exited by then, the alert fires. - `filterType` 'vehicleList', required — Enumerates available filter types: * plate: rule should be applied to a specific plate * vehicleList: rule to be applied to a specific vehicle list * anyPlateExcept: rule to be applied to all plates, except ones exempted in the provided vehicle list * allPlates: rule to be applied to all plates - `vehicleListIds` string[], required — Enumerates the IDs of all Vehicle Lists that are under the purview of this rule. - object — Configuration parameters for the Overstay rule - `alertTime` string, required — Daily clock time in 24-hour "HH:MM" format. When a vehicle entry is detected, an alert is scheduled for the next occurrence of this time. If the vehicle has not exited by then, the alert fires. - `filterType` 'anyPlateExcept', required — Enumerates available filter types: * plate: rule should be applied to a specific plate * vehicleList: rule to be applied to a specific vehicle list * anyPlateExcept: rule to be applied to all plates, except ones exempted in the provided vehicle list * allPlates: rule to be applied to all plates - `exemptionVehicleListIds` string[], required — Enumerates the IDs of all Vehicle Lists that are used for exemption of vehicles from the rule. - object — Configuration parameters for the Overstay rule - `alertTime` string, required — Daily clock time in 24-hour "HH:MM" format. When a vehicle entry is detected, an alert is scheduled for the next occurrence of this time. If the vehicle has not exited by then, the alert fires. - `filterType` 'allPlates', required — Enumerates available filter types: * plate: rule should be applied to a specific plate * vehicleList: rule to be applied to a specific vehicle list * anyPlateExcept: rule to be applied to all plates, except ones exempted in the provided vehicle list * allPlates: rule to be applied to all plates - `type` 'lprRuleOverstay' — A rule of type `lprRuleOverstay` triggers an alert when a vehicle that was seen entering has not exited by the next occurrence of a configured daily clock time (`alertTime`). For example, with `alertTime` set to `02:00`: a car entering at 11 PM will have its alert scheduled for 2 AM the following morning and the alert will fire at that time if the car has not exited by then. - `eventFilter` EventFilterForPatch — A list of attributes of the event used to funnel down a specific set of events for any downstream action. This filtering construct is as such independent of VSP and quite generic - `eventTypes` string[] — List of event types allowed to be processed by this rule - `schedule` WeeklyIntervalSchedule — It signifies a week long alert schedule. This schedule is effective according to actor's (user/camera/account) timezone. It allows setting different times for different days. - `sunday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `monday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `tuesday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `wednesday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `thursday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `friday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `saturday` Interval[] - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `resourceFilter` ResourceFilter — List of actors against which filtering to happen (camera/location/account) - `actors` ActorFilter[] — List of the actors for which events are checked. - `id` string — The id of the thing that caused the event This can be camera or location ID. If not supplied for any entry in the array, it is taken to mean as the entire account. - `type` 'camera' | 'location', required — Type of actor that caused the event. ## Response `204` Updated the rule ## Other responses - `400` — The supplied object is invalid. Error detail will contain the validation error. - `401` — You are not authenticated. Please authenticate and try again. - `403` — You have no permission to access the specified resource. - `404` — Referenced resource could not be found. - `500` — Something went wrong in the server. Please try again. --- [API](https://skmtc.net/eagleeyenetworks/apis/devices.md) · [All operations](https://skmtc.net/eagleeyenetworks/apis/devices/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/eagleeyenetworks/devices/revisions/df57313de545/schema)