Skip to content

Scenario Definition

Title: Scenario Definition

Type object
Required No
Additional properties Any type allowed

Description: Voluptuous validation schema for Scenario_Definition

Property Pattern Type Deprecated
- alias No string No
- enabled No string No
- condition No array of string No
- conditions No array of string No
- media No object No
- action_groups No array of string No
- delivery_selection No string No
- delivery No object No

Property Scenario Definition > alias

Type string
Required No

Property Scenario Definition > enabled

Type string
Required No
Default true

Property Scenario Definition > condition

Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
condition items -

Scenario Definition > condition > condition items

Type string
Required No

Property Scenario Definition > conditions

Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
conditions items -

Scenario Definition > conditions > conditions items

Type string
Required No

Property Scenario Definition > media

Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- camera_entity_id No string No
- camera_delay No integer No
- camera_ptz_preset No Combination No
- clip_url No string No
- snapshot_url No string No
- jpeg_opts No object No
- png_opts No object No

Property Scenario Definition > media > camera_entity_id

Type string
Required No

Property Scenario Definition > media > camera_delay

Type integer
Required No
Default 0

Property Scenario Definition > media > camera_ptz_preset

Type combining
Required No
Additional properties Any type allowed
Any of(Option)
item 0
item 1

Property Scenario Definition > media > camera_ptz_preset > anyOf > item 0

Type integer
Required No
Restrictions
Minimum ≥ 0

Property Scenario Definition > media > camera_ptz_preset > anyOf > item 1

Type object
Required No
Additional properties Any type allowed

Property Scenario Definition > media > clip_url

Type string
Required No

Property Scenario Definition > media > snapshot_url

Type string
Required No

Property Scenario Definition > media > jpeg_opts

Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- No object No

Property Scenario Definition > media > png_opts

Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- No object No

Property Scenario Definition > action_groups

Type array of string
Required No
Default []
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
action_groups items -

Scenario Definition > action_groups > action_groups items

Type string
Required No

Property Scenario Definition > delivery_selection

Type string
Required No

Property Scenario Definition > delivery

Type object
Required No
Additional properties Each additional property must conform to the schema
Default {}
Property Pattern Type Deprecated
- No object No

Property Scenario Definition > delivery > additionalProperties

Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- target No Combination No
- enabled No string No
- data No object No

Property Scenario Definition > delivery > additionalProperties > target

Type combining
Required No
Additional properties Any type allowed
Any of(Option)
item 0
item 1
item 2
Property Scenario Definition > delivery > additionalProperties > target > anyOf > item 0
Type object
Required No
Additional properties Each additional property must conform to the schema
Property Pattern Type Deprecated
- entity_id No array of string No
- device_id No array of string No
- area_id No array of string No
- floor_id No array of string No
- label_id No array of string No
- email No array of string No
- phone No array of string No
- mobile_app_id No array of string No
- person_id No array of string No
- No array of string No
Property Scenario Definition > delivery > additionalProperties > target > anyOf > item 0 > entity_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
entity_id items -
Scenario Definition > delivery > additionalProperties > target > anyOf > item 0 > entity_id > entity_id items
Type string
Required No
Property Scenario Definition > delivery > additionalProperties > target > anyOf > item 0 > device_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
device_id items -
Scenario Definition > delivery > additionalProperties > target > anyOf > item 0 > device_id > device_id items
Type string
Required No
Property Scenario Definition > delivery > additionalProperties > target > anyOf > item 0 > area_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
area_id items -
Scenario Definition > delivery > additionalProperties > target > anyOf > item 0 > area_id > area_id items
Type string
Required No
Property Scenario Definition > delivery > additionalProperties > target > anyOf > item 0 > floor_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
floor_id items -
Scenario Definition > delivery > additionalProperties > target > anyOf > item 0 > floor_id > floor_id items
Type string
Required No
Property Scenario Definition > delivery > additionalProperties > target > anyOf > item 0 > label_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
label_id items -
Scenario Definition > delivery > additionalProperties > target > anyOf > item 0 > label_id > label_id items
Type string
Required No
Property Scenario Definition > delivery > additionalProperties > target > anyOf > item 0 > email
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
email items -
Scenario Definition > delivery > additionalProperties > target > anyOf > item 0 > email > email items
Type string
Required No
Format email
Property Scenario Definition > delivery > additionalProperties > target > anyOf > item 0 > phone
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
phone items -
Scenario Definition > delivery > additionalProperties > target > anyOf > item 0 > phone > phone items
Type string
Required No
Property Scenario Definition > delivery > additionalProperties > target > anyOf > item 0 > mobile_app_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
mobile_app_id items -
Scenario Definition > delivery > additionalProperties > target > anyOf > item 0 > mobile_app_id > mobile_app_id items
Type string
Required No
Property Scenario Definition > delivery > additionalProperties > target > anyOf > item 0 > person_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
person_id items -
Scenario Definition > delivery > additionalProperties > target > anyOf > item 0 > person_id > person_id items
Type string
Required No
Property Scenario Definition > delivery > additionalProperties > target > anyOf > item 0 > additionalProperties
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
additionalProperties items -
Scenario Definition > delivery > additionalProperties > target > anyOf > item 0 > additionalProperties > additionalProperties items
Type string
Required No
Property Scenario Definition > delivery > additionalProperties > target > anyOf > item 1
Type string
Required No
Property Scenario Definition > delivery > additionalProperties > target > anyOf > item 2
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
item 2 items -
Scenario Definition > delivery > additionalProperties > target > anyOf > item 2 > item 2 items
Type string
Required No

Property Scenario Definition > delivery > additionalProperties > enabled

Type string
Required No

Property Scenario Definition > delivery > additionalProperties > data

Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- No object No

Generated using json-schema-for-humans on 2026-01-07 at 16:05:25 +0000