Home > Develop > Device Control by Cloud Solution > API Specs for Management > Device request

Export the device settings.

Estimated reading time: 3 minutes

Note:

The support information on this page may differ by region in terms of availability and timing.
*Japan : Support is scheduled for soon. API Specs for Provisioning is not supported. API Specs for Management is planned to be supported.
*China : Not supported

API

POST /devices/{deviceId}/settings-export/requests

Syntax

https://api.apps.rdm.sony.net/rms/v1/devices/{deviceId}/settings-export/requests

Authentication Level

ApiKeyAuth and AccessKeyAuth

Request Body schema

Request Body schema application/json Explanation
exportSettingIds object
schemaVersion Version of the settings spec schema.
specVersion Version of the settings spec.
ids Array of setting item ids.

Response

Response Schema application/json Explanation
Location   URL of created resource.
Response Schema application/json Explanation
errorCode API_KEY_NOT_FOUND API Key is not found.
ACCESS_KEY_NOT_FOUND Access Key is not found.
ASSET_NOT_FOUND Asset is not found.
ASSET_TOTAL_SIZE_ERROR The total size of the uploaded assets has exceeded the limit.
INVALID_API_KEY The API Key is invalid.
INVALID_ACCESS_KEY The Access Key is invalid.
INVALID_ARGUMENT Invalid argument. Need to check the request parameters.
INVALID_CSR Invalid argument. CSR is invalid.
INVALID_TOKEN Token is invalid.
INTERNAL_SERVER_ERROR Internal server error.
SERVICE_UNAVAILABLE Service unavailable.
REQUEST_NOT_FOUND Request is not found.
RESOURCE_BUSY Resource is busy.
RESOURCE_NOT_FOUND Resource is not found(except DEVICE_NOT_FOUND).
DEVICE_NOT_FOUND The device is not found.
DEVICE_NOT_SUPPORT The device is not support the api.
DEVICE_NOT_READY The device is not ready.
DEVICE_NOT_ONLINE The device is not online.
DEVICE_NETWORK_ERROR A network error is occurred on the device.
DEVICE_BUSY The device is busy. Please wait for a while and retry.
DEVICE_PRECONDITION_FAILED Precondition is not met to execute the request on the device.
DEVICE_STORAGE_NOT_ENOUGH Insufficient storage space on the device.
DEVICE_FATAL_ERROR Fatal error. Reboot the device and contact support if there is no improvement.
errorMessage Error message
Response Schema application/json Explanation
errorCode API_KEY_NOT_FOUND API Key is not found.
ACCESS_KEY_NOT_FOUND Access Key is not found.
ASSET_NOT_FOUND Asset is not found.
ASSET_TOTAL_SIZE_ERROR The total size of the uploaded assets has exceeded the limit.
INVALID_API_KEY The API Key is invalid.
INVALID_ACCESS_KEY The Access Key is invalid.
INVALID_ARGUMENT Invalid argument. Need to check the request parameters.
INVALID_CSR Invalid argument. CSR is invalid.
INVALID_TOKEN Token is invalid.
INTERNAL_SERVER_ERROR Internal server error.
SERVICE_UNAVAILABLE Service unavailable.
REQUEST_NOT_FOUND Request is not found.
RESOURCE_BUSY Resource is busy.
RESOURCE_NOT_FOUND Resource is not found(except DEVICE_NOT_FOUND).
DEVICE_NOT_FOUND The device is not found.
DEVICE_NOT_SUPPORT The device is not support the api.
DEVICE_NOT_READY The device is not ready.
DEVICE_NOT_ONLINE The device is not online.
DEVICE_NETWORK_ERROR A network error is occurred on the device.
DEVICE_BUSY The device is busy. Please wait for a while and retry.
DEVICE_PRECONDITION_FAILED Precondition is not met to execute the request on the device.
DEVICE_STORAGE_NOT_ENOUGH Insufficient storage space on the device.
DEVICE_FATAL_ERROR Fatal error. Reboot the device and contact support if there is no improvement.
errorMessage Error message
Response Schema application/json Explanation
errorCode object  
Last modified: 19 Feb 2025