This API end point lets read and write the recorder config in recording_config database. Based on parameter id backend automatically start monitoring and save the data in recording_data table based on saved configuration. On removing config from database will stop the monitoring.
Supported HTTP methods: GET, POST, PATCH, DELETE
GET /api/v1/recorderconfig
Gets all saved recorderconfig from database.
Parameters: none
Expected Payload: none.
Replied Payload: The list of stored configs as an array of RecorderConfig data objects.
Return Codes:
| Code | Description |
|---|---|
| 200 | OK, returns a JSON document. |
| 401 | not logged in. In this case an ApiError document is returned,describing details of the error. |
GET /api/v1/recorderconfig/{configId} Gets single saved recorderconfig from database with given configId.
Parameters:
| Parameter | Description |
|---|---|
| configId | The condifId of the config to get |
Expected Payload: none.
Replied Payload: The list of stored configs as an array of RecorderConfig data objects.
Return Codes:
| Code | Description |
|---|---|
| 200 | OK, returns the RecorderConfig containing the saved config. |
| 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/recorderconfig
Creates a new recorder config with the given attributes. The unique keyId is generated by the database backend and returned in the response document.
Parameters: none
Expected Payload: A RecorderConfig data object to store.
Replied Payload: A RecorderConfig list containing the data replied by the database.
Return Codes:
| Code | Description |
|---|---|
| 201 | Created, the created RecorderConfig data object is replied as payload |
| 401 | not logged in. In this case an ApiError document is returned,describing details of the error. |
| 400 | Bad Request. If parameterId_ is not given. |
| 500 | DB is not writable. In this case an ApiError document is returned,describing details of the error. |
PATCH /api/v1/recorderconfig/{configId}
Updates an existing recorder config with the given configId from the attached RecorderConfig data object.
| Parameter | Description |
|---|---|
| configId | The condifId of the config to get |
Expected Payload: A RecorderConfig data object to store.
Replied Payload: A RecorderConfig list containing the data replied by the database.
Return Codes:
| Code | Description |
|---|---|
| 200 | OK, changed RecorderConfig data object is replied as payload |
| 400 | Bad Request. If parameterId_ is not given. |
| 401 | not logged in. In this case an ApiError document is returned,describing details of the error. |
| 404 | the config is not found with given configId. |
| 500 | DB is not writable. In this case an ApiError document is returned,describing details of the error. |
DELETE /api/v1/recorderconfig/{configId}
Remove a recorder config from the database
| Parameter | Description |
|---|---|
| configId | The condifId of the config to get |
Parameters: none
Expected Payload: none
Replied Payload: none
Return Codes:
| Code | Description |
|---|---|
| 204 | NO CONTENT, the config has been deleted. |
| 400 | Bad Request. In case validation falied on payload |
| 401 | not logged in. In this case an ApiError document is returned,describing details of the error. |
| 404 | the config is not found with given configId. |
| 500 | DB is not writable. In this case an ApiError document is returned,describing details of the error. |