RegionCloseApproachRuleModel
Fields
Section titled “Fields”| Field | Type | Required | Description and constraints |
|---|---|---|---|
id |
string | Yes | minimum length 1. maximum length 128. pattern ^[A-Za-z0-9][A-Za-z0-9._:-]*$ |
label |
string | Yes | minimum length 1. maximum length 256 |
severity |
RuleSeverity | No | default "warning" |
enabled |
boolean | No | default true |
actions |
array of WebhookActionModel or GenetecActionModel or NotificationProfileActionModel or RecordClipActionModel | No | maximum items 16. default [] |
schedule |
RuleScheduleModel or null | No | |
type |
"closeApproach" |
Yes | |
primaryConfigurationId |
string | Yes | minimum length 1. maximum length 128. pattern ^[A-Za-z0-9][A-Za-z0-9._:-]*$ |
secondaryConfigurationId |
string | Yes | minimum length 1. maximum length 128. pattern ^[A-Za-z0-9][A-Za-z0-9._:-]*$ |
distanceMode |
CloseApproachDistanceMode | No | default "imagePercent" |
maximumDistance |
number | No | greater than 0.0. maximum 1000.0. default 10 |
calibration |
PlanarCalibrationModel or null | No | |
minimumPrimarySpeedPixelsPerSecond |
number | No | minimum 0.0. maximum 100000.0. default 0 |
minimumSecondarySpeedPixelsPerSecond |
number | No | minimum 0.0. maximum 100000.0. default 0 |
requireClosing |
boolean | No | default false |
minimumClosingSpeedPixelsPerSecond |
number | No | minimum 0.0. maximum 100000.0. default 0 |
speedWindowSeconds |
number | No | greater than 0.0. maximum 60.0. default 1 |
minimumSpeedWindowSeconds |
number | No | minimum 0.0. maximum 60.0. default 0.4 |
closingWindowSeconds |
number | No | greater than 0.0. maximum 60.0. default 1 |
closeMemorySeconds |
number | No | minimum 0.0. maximum 60.0. default 1 |
dwellSeconds |
number | No | minimum 0.0. maximum 86400.0. default 1 |
resetSeconds |
number | No | greater than 0.0. maximum 86400.0. default 10 |
Additional properties are rejected by this schema.
JSON schema
Section titled “JSON schema”{ "properties": { "id": { "type": "string", "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]*$", "title": "Id" }, "label": { "type": "string", "maxLength": 256, "minLength": 1, "title": "Label" }, "severity": { "$ref": "#/components/schemas/RuleSeverity", "default": "warning" }, "enabled": { "type": "boolean", "title": "Enabled", "default": true }, "actions": { "items": { "oneOf": [ { "$ref": "#/components/schemas/WebhookActionModel" }, { "$ref": "#/components/schemas/GenetecActionModel" }, { "$ref": "#/components/schemas/NotificationProfileActionModel" }, { "$ref": "#/components/schemas/RecordClipActionModel" } ], "discriminator": { "propertyName": "type", "mapping": { "genetec": "#/components/schemas/GenetecActionModel", "notificationProfile": "#/components/schemas/NotificationProfileActionModel", "recordClip": "#/components/schemas/RecordClipActionModel", "webhook": "#/components/schemas/WebhookActionModel" } } }, "type": "array", "maxItems": 16, "title": "Actions", "default": [] }, "schedule": { "anyOf": [ { "$ref": "#/components/schemas/RuleScheduleModel" }, { "type": "null" } ] }, "type": { "type": "string", "const": "closeApproach", "title": "Type" }, "primaryConfigurationId": { "type": "string", "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]*$", "title": "Primaryconfigurationid" }, "secondaryConfigurationId": { "type": "string", "maxLength": 128, "minLength": 1, "pattern": "^[A-Za-z0-9][A-Za-z0-9._:-]*$", "title": "Secondaryconfigurationid" }, "distanceMode": { "$ref": "#/components/schemas/CloseApproachDistanceMode", "default": "imagePercent" }, "maximumDistance": { "type": "number", "maximum": 1000.0, "exclusiveMinimum": 0.0, "title": "Maximumdistance", "default": 10 }, "calibration": { "anyOf": [ { "$ref": "#/components/schemas/PlanarCalibrationModel" }, { "type": "null" } ] }, "minimumPrimarySpeedPixelsPerSecond": { "type": "number", "maximum": 100000.0, "minimum": 0.0, "title": "Minimumprimaryspeedpixelspersecond", "default": 0 }, "minimumSecondarySpeedPixelsPerSecond": { "type": "number", "maximum": 100000.0, "minimum": 0.0, "title": "Minimumsecondaryspeedpixelspersecond", "default": 0 }, "requireClosing": { "type": "boolean", "title": "Requireclosing", "default": false }, "minimumClosingSpeedPixelsPerSecond": { "type": "number", "maximum": 100000.0, "minimum": 0.0, "title": "Minimumclosingspeedpixelspersecond", "default": 0 }, "speedWindowSeconds": { "type": "number", "maximum": 60.0, "exclusiveMinimum": 0.0, "title": "Speedwindowseconds", "default": 1 }, "minimumSpeedWindowSeconds": { "type": "number", "maximum": 60.0, "minimum": 0.0, "title": "Minimumspeedwindowseconds", "default": 0.4 }, "closingWindowSeconds": { "type": "number", "maximum": 60.0, "exclusiveMinimum": 0.0, "title": "Closingwindowseconds", "default": 1 }, "closeMemorySeconds": { "type": "number", "maximum": 60.0, "minimum": 0.0, "title": "Closememoryseconds", "default": 1 }, "dwellSeconds": { "type": "number", "maximum": 86400.0, "minimum": 0.0, "title": "Dwellseconds", "default": 1 }, "resetSeconds": { "type": "number", "maximum": 86400.0, "exclusiveMinimum": 0.0, "title": "Resetseconds", "default": 10 } }, "additionalProperties": false, "type": "object", "required": [ "id", "label", "type", "primaryConfigurationId", "secondaryConfigurationId" ], "title": "RegionCloseApproachRuleModel"}