REST API Devices Routes Configuration Load config

April 13, 2023 at 2:39 AM

Load a configuration into the device

Role

Write all the configuration registers into a device, then restart it to apply the new configuration. The difference with Write a configuration lies in how the configuration’s data are retrieved. This function is intented to retrieve and write a configuration that is stored remotely, given its URL.

Prototype

URL : /device/{$id}/load-config[?specific={$specific}]

Method : PUT

URL Params :

  • {$id} : the DeviceId of the device. Use GET /devices to enumerate the connected devices.
  • {$specific} : how to handle the device-specific registers. Possible values are discard (don’t care for current values, write all the registers including the device-specific ones) and preserve (keep the current value of device-specific registers if they are already defined, ignore the corresponding data entries). Default is discard.

Request data :

Field name Type Status Description
File string option The configuration file name or URL.
Local files: start the string with “file://”
Remote files: start the string with either “http://” or “https://”
Other schemes (FTP etc) are not supported.
Blob string option The content of the configuration file itself, in base64.
This is namely of CONFIG_DATA JSON object; the base64 encoding is required so the transmission through a higher level JSON object is seamless.

File and Blob are both optional, but one of the two shall be provided (not both).

Success Response

Code : 200 OK

Content : a CONFIG-GUID object, as specified below.

CONFIG-GUID object definition

Field name Type Status Description
Result string always Constant value: success
ConfigId string always The new configuration GUID of the device

Example

{
	"Result": "success",
	"ConfigId": "80B4667D-71D0-0BDC-AA81-95DCA20A44E1"
}

Error Response

See Error Responses.