Reads and stores the diagram settings for a given file recorder device.
Supported HTTP methods: GET, PUT, HEAD, OPTIONS
GET /api/v1/filerecordersettings/{mncName}/{deviceName}
Reads the diagram settings for a given file recorder device.
Parameters:
| Parameter | Description |
|---|---|
| mncName | The name of the M&C to read the data from |
| deviceName | The name of the File-Recorder device to read the data from |
Expected Payload: none.
Replied Payload: The diagram settings as a FRViewProperties document.
Return Codes:
| Code | Description |
|---|---|
| 200 | OK, the requested file recorder data is returned. |
| 400 | The M&C is offline, cannot be queried. In this case an ApiError document is returned, describing details of the error. |
| 401 | Not logged in. In this case an ApiError document is returned, describing details of the error. |
| 404 | Either the referred M&C or the device does not exists or the device is not a File-Recorder device. In this case an ApiError document is returned, describing details of the error. |
PUT /api/v1/filerecordersettings/{mncName}/{deviceName}
Stores the diagram settings for a given file recorder device.
Parameters:
| Parameter | Description |
|---|---|
| mncName | The name of the M&C to store the data to |
| deviceName | The name of the File-Recorder device to store the data for |
Expected Payload: The diagram settings to store as a FRViewProperties document.
Replied Payload: Echoes back the stored data (after storing it at the destination M&C and reading it back from there).
Return Codes:
| Code | Description |
|---|---|
| 200 | OK, the echoed back diagram settings document is returned. |
| 400 | The M&C is offline, data cannot be stored. In this case an ApiError document is returned, describing details of the error. |
| 401 | Not logged in. In this case an ApiError document is returned, describing details of the error. |
| 404 | Either the referred M&C or the device does not exists or the device is not a File-Recorder device. In this case an ApiError document is returned, describing details of the error. |