8.2.18 /api/v1/applypreset

Applies a preset on a given M&C.

Supported HTTP methods: POST, HEAD, OPTIONS

POST /api/v1/applypreset/{mncName}/{deviceName}

Applies a preset to the given device. Expects a DevicePreset as request body, then delegates the request to the M&C.

Parameters:

Parameter Description
mncName The name of the M&C at which the preset shall be applied.
deviceName The name of the device to apply the preset to.

Return Codes:

Code Description
200 OK, returns the DevicePreset containing the applied preset.
401 not logged in. In this case a ApiError document is returned, describing details of the error.
404 no M&C with the given name exists. In this case a ApiError document is returned, describing details of the error.

POST /api/v1/applypreset/{mncName}/{driverName}/{deviceName}/{presetName}

Applies the referenced preset to the given device. Expects no request body, simply delegates the request to the M&C.

Parameters:

Parameter Description
mncName The name of the M&C at which the preset shall be applied.
driverName The name of the device driver for which the preset shall be applied.
deviceName The name of the device to apply the preset to.
presetName The name of the preset to apply.

Return Codes:

Code Description
200 OK, returns the DevicePreset containing the applied preset.
401 not logged in. In this case a ApiError document is returned, describing details of the error.
404 either M&C with the given name exists or at the known M&C there exists no driver/device/preset with the requested name. In this case a ApiError document is returned, describing details of the error.