settings_package_save_init

_^Tech

Uploads (optionally encrypted) ZIP file with configuration to the device. Since the update can take a long time, and the device can go offline in the process, it is done asynchronously. This call starts the process, and settings_save_reconnect checks the result. The specification of after how long, how often and for how long is the check called is part of the return value.

If the submitted data contain a validation error an Error object will be returned. The individual violations will be listed in the suberrors attribute.

Params

attribute	description
base64* string	Base64 encoded ZIP file (*.zip) containing the configuration
encryption_passphrase string	A passphrase used to decrypt the uploaded ZIP file

Return

Note

Both error and result objects can be present in the response. This happens when data validation failed and config_data objects hold the actually validated data. These can differ slightly from the submitted data due to automatic tweaks to accommodate for configuration version, HW modules, SW keys etc..

If the supplied data were valid, and the update process started, the delay, interval, timeout and session_id must be present.

attribute	description
config_data* Config Data	The new configuration data as interpreted by the device, it might differ from the supplied data
config_meta* Config Meta@settings_meta	Field metadata for the config_data
config_tree* Config Tree@settings_tree	Tree view definition for the config_meta and config_data
delay* unsigned int	Indicates in how many seconds the client should attempt to reestablish the connection. The value must be lower than timeout.
interval* unsigned int	The interval in seconds between attempts to reconnect after the initial delay
interval_increase* unsigned int	By how many seconds should increase the interval between attempts
timeout* unsigned int	Indicates after how many seconds should attempts to reestablish connection be given up. It is measured from the moment the response to this call was received by the client. Its value must be greater than delay.
session_id* string	The session ID to be used when reconnecting