Update Alert Rule

PUT {{baseUrl}}/v1/alert-rule/:alertRuleUid

Update one existing alert rule by alertRuleUid.

Parameters

Field	Type	Required	Description
`alertRuleUid`	string	required	Unique Alert Rule Identification

Body

Field	Type	Required	Description
`name`	string	optional	New name of the updated alert rule
`description`	string	optional	New description
`alertType`	string	optional	Accepted values 'DEVICE', 'POLICY', 'APPLET'
`organizationUids`	array	optional	Organizations which is checked against the rule
`filter`	object	optional	Pre-filter of devices which the alert will be checked against. It's used for percentage threshold of alert creation as base. The mandatory filter is organization set above. This is extended filter for example device applicationType (tizen, webos, etc.).
`conditions`	object	optional	Specify all conditions which devices has to match to state alert as applicable.
`threshold`	object	optional	Specify threshold of rule. It is comparing number of devices matched the conditions above relatively against the total number devices filtered by filter above
`periodicity`	object	optional	Specify how often the rule will be checked against the current state of devices.
`action`	object	optional	Optionally specify the action of alert rule. This action will happen when alert rule is creating an alert.

Filter

Field	Type	Required	Description
`applicationType`	string	optional	Type of application one of ('sssp', 'tizen', 'webos', 'android', 'chrome', 'brightsign', 'linux', 'windows', 'default' )
`applicationVersion`	array	optional	Semver comparison of core app version [SemverOperator, string] - ([>, 3.12.0])
`frontDisplayVersion`	array	optional	Semver comparison of internal front-display library version[SemverOperator, string] - ([>, 9.15.0])
`firmwareType`	string	optional	Partial matching of string
`firmwareVersion`	string	optional	Partial matching of string
`managementPackageVersion`	array	optional	Semver comparison of core management package version ([>, 3.12.0])
`frontPackageVersion`	array	optional	Semver comparison of core front package version ([>, 3.12.0])
`tagUids`	string	optional	List of tags. Device has match all tags in list
`model`	string	optional	Partial matching of string
`name`	string	optional	Partial matching of string
`extendedManagement`	boolean	optional	Filter device with or without extended management
`extendedManagement`	Date	optional	Filter only devices provisioned since the date
`supportedResolutions`	ResolutionItem	optional	Filter only devices supporting specified resolution
`locationUids`	array	optional	Filter only devices in specified locations
`locationTagsUids`	array	optional	Filter only devices in specified location tags

Conditions

NumericOperator

Operators
>
<
<=
>=
=
!=

TimeRangeOperator

Operators
>
<

Conditions values types

Condition type	Type	Example
`OCCURRENCES_IN_TIME_RANGE_TO_PAST`	array	[operator: NumericOperator, occurrences: number, rangeInPastMs: number] -([>, 12, 36000])
`NUMERIC_RANGE`	array	[operator: NumericOperator, nmbr: number] - (>, 12)
`STRING_OCCURRENCES_IN_TIME_RANGE_TO_PAST`	array	[str: string, operator: NumericOperator, occurrences: number, rangeInPastMs: number] - (action, > 12, 36000)
`TIME_RANGE_TO_PAST`	array	[operator: TimeRangeOperator, rangeInPastMs: number] - (<, 36000)
`PERCENTAGE_RANGE`	array	[operator: NumericOperator, percentage: number] - (<, 50)
`NUMERIC_RANGE`	array	[operator: NumericOperator, nmbr: number] - (<, 50)
`NUMERIC_RANGE`	string	'DEVICE'
`MATCH_SEMVER`	array	[operator: SemverOperator, version: string] - (>, 3.12.0)
`STRING_LIST`	array	[string1, string2]
`POLICY_LIST`	string	One of ('VOLUME', 'BRIGHTNESS', 'TIMERS', 'PROPRIETARYTIMERS', 'RESOLUTION', 'ORIENTATION', 'REMOTECONTROL', 'APPLICATIONVERSION', 'FIRMWAREVERSION', 'DEBUG', 'DATETIME', 'POWERACTIONSSCHEDULE', 'TEMPERATURE', 'BUNDLED_APPLET')
`WIFI_OR_ETHERNET`	string	One of ('wifi', 'ethernet')
`INPUT_SOURCE`	string	One of ('urlLauncher', 'hdmi1', 'hdmi2', 'hdmi3', 'hdmi4')
`TIMERS`	array	TimerSettings[]
`RESOLUTION`	object	ResolutionItem
`ORIENTATION`	object	OrientationSettings

Device condition

Condition	Condition values	Description
`INCORRECT_TIME`	BOOLEAN	Is used when device has incorrect time based on current time & timezone of device
`INVALID_SSL_CERTIFICATE`	BOOLEAN	Is used when device is detected having some problems with SSL certificates (it can be even time related)
`FAILED_ACTIONS`	BOOLEAN	Is used when device performing/executing action has failed for amount of time in past
`CONNECTIONS`	BOOLEAN	Is used when device performing/executing action has failed for amount of time in past
`MODEL`	array	BOOLEAN if device has model or not
`SERIAL_NUMBER`	BOOLEAN	Check if device has serial number or not
`NAME`	string	Check if device partially match some string
`PIN_CODE`	boolean	Check if device has PIN code reported
`MANAGEMENT_PACKAGE_VERSION`	MATCH_SEMVER	Check if device match semver version
`FRONT_PACKAGE_VERSION`	MATCH_SEMVER	Check if device match semver version
`FRONT_DISPLAY_VERSION`	MATCH_SEMVER	Check if device match semver version
`FIRMWARE_TYPE`	string	Check if device match semver version
`TAG_UIDS`	STRING_LIST	Check if device has selected tags
`POLICIES`	POLICY_LIST	Check if device has selected policy settings
`LAST_PROVISION_AT`	TIMERANGETO_PAST	Check if device was provisioned in specified time range in past. Useful to detect new devices are provisioned
`LAST_DEPROVISION_AT`	TIMERANGETO_PAST	Check if device was deprovisioned in specified time range in past. Useful to detect devices are re-provisioned
`EXTENDED_MANAGEMENT`	BOOLEAN	Check if device has access to extended management
`ALIVE_AT`	TIMERANGETO_PAST	Check if device last ping in specified time range in past
`NETWORK_INTERFACES`	WIFIORETHERNET	Check if device is connected using WiFi or Ethernet
`BATTERY_STATUS`	PERCENTAGE_RANGE	Check if device has enough or not enough battery
`STORAGE_STATUS`	PERCENTAGE_RANGE	Check if device has or has not enough free storage
`CURRENT_TIMEZONE`	MATCH_STRING	Check if timezone match the string
`DISPLAY_SETTING_BACKLIGHT`	PERCENTAGE_RANGE	Check if match expected value of display settings
`DISPLAY_SETTING_CONTRAST`	PERCENTAGE_RANGE	Check if match expected value of display settings
`DISPLAY_SETTING_SHARPNESS`	PERCENTAGE_RANGE	Check if match expected value of display settings
`DISPLAY_SETTING_MAX_TEMPERATURE`	NUMERIC_RANGE	Max temperature in celsius
`INPUT_SOURCE`	INPUT_SOURCE	Check if current input source is set to specified source
`VOLUME`	PERCENTAGE_RANGE	Check if current volume is expected
`BRIGHTNESS`	PERCENTAGE_RANGE	Check if current brightness is expected
`TIMERS`	TIMERS	Check if current native timers are set as expected
`PROPRIETARY_TIMERS`	TIMERS	Check if current proprietary timers are set as expected
`RESOLUTION`	RESOLUTION	Check if current resolution is set as expected
`ORIENTATION`	ORIENTATION	Check if current orientation is set as expected
`REMOTE_CONTROL`	BOOLEAN	Check if current RC is locked or not
`APPLICATION_VERSION`	MATCH_SEMVER	Check if current core app version is correct
`FIRMWARE_VERSION`	MATCH_STRING	Check if current FW version match some string
`DEBUG`	BOOLEAN	Check if debug is enabled or not
`POWER_ACTIONS_SCHEDULE`	SCHEDULEDPOWERACTIONS	Check if current scheduled power actions are correctly set
`TEMPERATURE`	NUMERIC_RANGE	Check if current scheduled power actions are correctly set
`INSTALLED_PACKAGE`	MATCH_STRING	Check if specified package is installed
`SCREENSHOT`	OCCURRENCESINTIMERANGETO_PAST	Check if number of screenshots was received in time
`FEATURE_TESTS`	BOOLEAN	Check if feature tests has passed

Policy condition

Condition	Condition values	Description
`POLICY_VIOLATION_VOLUME`	BOOLEAN	Check violation of any of existing policy device settings type
`POLICY_VIOLATION_BRIGHTNESS`	BOOLEAN	Check violation of any of existing policy device settings type
`POLICY_VIOLATION_TIMERS`	BOOLEAN	Check violation of any of existing policy device settings type
`POLICY_VIOLATION_PROPRIETARY_TIMERS`	BOOLEAN	Check violation of any of existing policy device settings type
`POLICY_VIOLATION_RESOLUTION`	BOOLEAN	Check violation of any of existing policy device settings type
`POLICY_VIOLATION_ORIENTATION`	BOOLEAN	Check violation of any of existing policy device settings type
`POLICY_VIOLATION_REMOTE_CONTROL`	BOOLEAN	Check violation of any of existing policy device settings type
`POLICY_VIOLATION_APPLICATION_VERSION`	BOOLEAN	Check violation of any of existing policy device settings type
`POLICY_VIOLATION_FIRMWARE_VERSION`	BOOLEAN	Check violation of any of existing policy device settings type
`POLICY_VIOLATION_DEBUG`	BOOLEAN	Check violation of any of existing policy device settings type
`POLICY_VIOLATION_DATETIME`	BOOLEAN	Check violation of any of existing policy device settings type
`POLICY_VIOLATION_POWER_ACTIONS_SCHEDULE`	BOOLEAN	Check violation of any of existing policy device settings type
`POLICY_VIOLATION_TEMPERATURE`	BOOLEAN	Check violation of any of existing policy device settings type

Applet condition

Condition	Condition values	Description
`APPLET_COMMAND`	STRINGOCCURRENCESINTIMERANGETOPAST	Is used when to check custom user defined commands occurrences in time

Threshold

Field	Type	Required	Description
`type`	string	required	Currently only percentage implemented - percentage'
`percentage`	number	required	The number of percent from 0 to 99 (100 is never matched)

Periodicity

Field	Type	Required	Description
`interval`	string	required	How often alert will be checked against current state in SECONDS'
`activeTimeWindows`	array	required	Alert rule won't be checked against current state out of specified active time windows when at least one specified. If no active time window specified, alert rule will be checked anytime.

Action

Account alert actions

Action type	Type	Required	Description
`type`	string	required	All specified accounts are notified using account notification settings' - (type: 'accounts')
`accountIds`	array of accountIds	required	AccountIds in array, which will be notified about alert

Organization accounts alert actions

Action type	Type	Required	Description
`type`	string	required	All accounts assigned to organization of creating rule are notified using account notification settings' (type: 'organization_accounts')

Email alert actions

Action type	Type	Required	Description
`type`	string	required	All accounts assigned to organization of creating rule are notified using account notification settings' (type: 'emailAddresses')
`emailAddresses`	array of emails	required	Array of email addresses, which will be notified about alert

HEADERS

Key	Datatype	Description
`x-auth`	string	Authorization key and token
`Content-Type`	string
`Content-Type`	string
`Accept`	string

RESPONSES

status: OK

{}