Transport Definition¶

JSON Schema: Transport_Definition.schema.json

Title: Transport Definition


Type	`object`
Required	No
Additional properties	Not allowed

Description: Voluptuous validation schema for Transport_Definition

Property	Pattern	Type	Deprecated
- alias	No	string	No
- load	No	boolean	No
- enabled	No	boolean	No
- delivery_defaults	No	object	No
- connection	No	object	No
- device_domain	No	array of string	No
- device_model_include	No	array of string	No
- device_model_exclude	No	array of string	No
- device_discovery	No	boolean	No

Property `Transport Definition > alias`¶


Type	`string`
Required	No

Property `Transport Definition > load`¶


Type	`boolean`
Required	No
Default	`true`

Property `Transport Definition > enabled`¶


Type	`boolean`
Required	No
Default	`true`

Property `Transport Definition > delivery_defaults`¶


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated
- action	No	string	No
- debug	No	boolean	No
- options	No	object	No
- data	No	object	No
- target	No	Combination	No
- target_required	No	Combination	No
- target_usage	No	enum (of string)	No
- inclusion	No	array of enum (of string)	No
- priority	No	array	No
- selection_rank	No	enum (of string)	No
- alias	No	string	No
- template	No	string	No
- message	No	string	No
- title	No	string	No
- occupancy	No	enum (of string)	No
- conditions	No	array of string	No

Property `Transport Definition > delivery_defaults > action`¶


Type	`string`
Required	No

Property `Transport Definition > delivery_defaults > debug`¶


Type	`boolean`
Required	No

Property `Transport Definition > delivery_defaults > options`¶


Type	`object`
Required	No
Additional properties	Any type allowed

Property	Pattern	Type	Deprecated
- Additional properties	No	object	No

Property `Transport Definition > delivery_defaults > data`¶


Type	`object`
Required	No
Additional properties	Each additional property must conform to the schema

Property	Pattern	Type	Deprecated
- Additional properties	No	Combination	No

Property `Transport Definition > delivery_defaults > data > additionalProperties`¶


Type	`combining`
Required	No
Additional properties	Any type allowed

Any of(Option)
item 0
item 1
item 2
item 3
item 4
item 5
item 6

Property `Transport Definition > delivery_defaults > data > additionalProperties > anyOf > item 0`¶


Type	`string`
Required	No

Property `Transport Definition > delivery_defaults > data > additionalProperties > anyOf > item 1`¶


Type	`integer`
Required	No

Property `Transport Definition > delivery_defaults > data > additionalProperties > anyOf > item 2`¶


Type	`boolean`
Required	No

Property `Transport Definition > delivery_defaults > data > additionalProperties > anyOf > item 3`¶


Type	`number`
Required	No

Property `Transport Definition > delivery_defaults > data > additionalProperties > anyOf > item 4`¶


Type	`object`
Required	No
Additional properties	Any type allowed

Property	Pattern	Type	Deprecated
- Additional properties	No	object	No

Property `Transport Definition > delivery_defaults > data > additionalProperties > anyOf > item 5`¶


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 5 items	-

Transport Definition > delivery_defaults > data > additionalProperties > anyOf > item 5 > item 5 items¶


Type	`string`
Required	No

Property `Transport Definition > delivery_defaults > data > additionalProperties > anyOf > item 6`¶


Type	`object`
Required	No
Additional properties	Any type allowed

Description: Must be null

Property `Transport Definition > delivery_defaults > target`¶


Type	`combining`
Required	No
Additional properties	Any type allowed

Any of(Option)
item 0
item 1
item 2

Property `Transport Definition > delivery_defaults > 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
- Additional properties	No	array of string	No

Property `Transport Definition > delivery_defaults > 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	-

Transport Definition > delivery_defaults > target > anyOf > item 0 > entity_id > entity_id items¶


Type	`string`
Required	No

Property `Transport Definition > delivery_defaults > 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	-

Transport Definition > delivery_defaults > target > anyOf > item 0 > device_id > device_id items¶


Type	`string`
Required	No

Property `Transport Definition > delivery_defaults > 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	-

Transport Definition > delivery_defaults > target > anyOf > item 0 > area_id > area_id items¶


Type	`string`
Required	No

Property `Transport Definition > delivery_defaults > 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	-

Transport Definition > delivery_defaults > target > anyOf > item 0 > floor_id > floor_id items¶


Type	`string`
Required	No

Property `Transport Definition > delivery_defaults > 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	-

Transport Definition > delivery_defaults > target > anyOf > item 0 > label_id > label_id items¶


Type	`string`
Required	No

Property `Transport Definition > delivery_defaults > 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	-

Transport Definition > delivery_defaults > target > anyOf > item 0 > email > email items¶


Type	`string`
Required	No

Property `Transport Definition > delivery_defaults > 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	-

Transport Definition > delivery_defaults > target > anyOf > item 0 > phone > phone items¶


Type	`string`
Required	No

Property `Transport Definition > delivery_defaults > 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	-

Transport Definition > delivery_defaults > target > anyOf > item 0 > mobile_app_id > mobile_app_id items¶


Type	`string`
Required	No

Property `Transport Definition > delivery_defaults > 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	-

Transport Definition > delivery_defaults > target > anyOf > item 0 > person_id > person_id items¶


Type	`string`
Required	No

Property `Transport Definition > delivery_defaults > 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	-

Transport Definition > delivery_defaults > target > anyOf > item 0 > additionalProperties > additionalProperties items¶


Type	`string`
Required	No

Property `Transport Definition > delivery_defaults > target > anyOf > item 1`¶


Type	`string`
Required	No

Property `Transport Definition > delivery_defaults > 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	-

Transport Definition > delivery_defaults > target > anyOf > item 2 > item 2 items¶


Type	`string`
Required	No

Property `Transport Definition > delivery_defaults > target_required`¶


Type	`combining`
Required	No
Additional properties	Any type allowed

Any of(Option)
item 0
item 1

Property `Transport Definition > delivery_defaults > target_required > anyOf > item 0`¶


Type	`boolean`
Required	No

Property `Transport Definition > delivery_defaults > target_required > anyOf > item 1`¶


Type	`enum (of string)`
Required	No

Must be one of: * "always" * "never" * "optional"

Property `Transport Definition > delivery_defaults > target_usage`¶


Type	`enum (of string)`
Required	No

Must be one of: * "no_delivery" * "no_action" * "merge_delivery" * "merge_always" * "fixed"

Property `Transport Definition > delivery_defaults > inclusion`¶


Type	`array of enum (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
inclusion items	-

Transport Definition > delivery_defaults > inclusion > inclusion items¶


Type	`enum (of string)`
Required	No

Must be one of: * "fallback_on_error" * "explicit" * "scenario" * "default" * "fallback"

Property `Transport Definition > delivery_defaults > priority`¶


Type	`array`
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
priority items	-

Transport Definition > delivery_defaults > priority > priority items¶


Type	`combining`
Required	No
Additional properties	Any type allowed

Any of(Option)
item 0
item 1
item 2

Property `Transport Definition > delivery_defaults > priority > priority items > anyOf > item 0`¶


Type	`integer`
Required	No

Property `Transport Definition > delivery_defaults > priority > priority items > anyOf > item 1`¶


Type	`string`
Required	No

Property `Transport Definition > delivery_defaults > priority > priority items > anyOf > item 2`¶


Type	`enum (of string)`
Required	No

Must be one of: * "minimum" * "low" * "medium" * "high" * "critical"

Property `Transport Definition > delivery_defaults > selection_rank`¶


Type	`enum (of string)`
Required	No

Must be one of: * "ANY" * "FIRST" * "LAST"

Property `Transport Definition > delivery_defaults > alias`¶


Type	`string`
Required	No

Property `Transport Definition > delivery_defaults > template`¶


Type	`string`
Required	No

Property `Transport Definition > delivery_defaults > message`¶


Type	`string`
Required	No

Property `Transport Definition > delivery_defaults > title`¶


Type	`string`
Required	No

Property `Transport Definition > delivery_defaults > occupancy`¶


Type	`enum (of string)`
Required	No

Must be one of: * "all_in" * "all_out" * "any_in" * "any_out" * "only_in" * "only_out" * "all" * "none"

Property `Transport Definition > delivery_defaults > 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	-

Transport Definition > delivery_defaults > conditions > conditions items¶


Type	`string`
Required	No

Property `Transport Definition > connection`¶


Type	`object`
Required	No
Additional properties	Not allowed

Property	Pattern	Type	Deprecated
+ host	No	string	No
- port	No	integer	No
- encryption	No	enum (of string)	No
- username	No	string	No
- password	No	string	No
- timeout	No	integer	No
- verify_ssl	No	boolean	No

Property `Transport Definition > connection > host`¶


Type	`string`
Required	Yes

Property `Transport Definition > connection > port`¶


Type	`integer`
Required	No
Default	`587`

Restrictions
Minimum	≥ 1
Maximum	≤ 65535

Property `Transport Definition > connection > encryption`¶


Type	`enum (of string)`
Required	No
Default	`"starttls"`

Must be one of: * "tls" * "starttls" * "none"

Property `Transport Definition > connection > username`¶


Type	`string`
Required	No

Property `Transport Definition > connection > password`¶


Type	`string`
Required	No

Property `Transport Definition > connection > timeout`¶


Type	`integer`
Required	No
Default	`5`

Restrictions
Minimum	≥ 0

Property `Transport Definition > connection > verify_ssl`¶


Type	`boolean`
Required	No
Default	`true`

Property `Transport Definition > device_domain`¶


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_domain items	-