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

Get all request information.

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

GET /devices/{deviceId}/requests

Syntax

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

Authentication Level

ApiKeyAuth and AccessKeyAuth

Response

Response Schema application/json Explanation
requests Requests list.
requestId Request ID.
status object
code Enum: "WAITING" "PREPARING" "REQUESTED" "ACCEPTED" "IN_PROGRESS" "COMPLETED" "FAILED" "CANCELED"
Status code
  • WAITING - Waiting for the request to start.
  • PREPARING - Preparing the request to device.
  • REQUESTED - Requested to device.
  • ACCEPTED - Device accepted the request.
  • IN_PROGRESS - The request is in progress on device.
  • COMPLETED - The request is completed.
  • FAILED - The request is failed.
  • CANCELED - The request is canceled.
    		•
    progress [Conditional code==IN_PROGRESS] Progressing status(%).
    errorCode Enum: "API_KEY_NOT_FOUND" "ACCESS_KEY_NOT_FOUND" "ASSET_NOT_FOUND ASSET_TOTAL_SIZE_ERROR" "INVALID_API_KEY" "INVALID_ACCESS_KEY" "INVALID_ARGUMENT" "INVALID_CSR" "INVALID_TOKEN" "INTERNAL_SERVER_ERROR" "SERVICE_UNAVAILABLE" "REQUEST_NOT_FOUND" "RESOURCE_BUSY" "RESOURCE_NOT_FOUND" "DEVICE_NOT_FOUND" "DEVICE_NOT_SUPPORT" "DEVICE_NOT_READY" "DEVICE_NOT_ONLINE" "DEVICE_NETWORK_ERROR" "DEVICE_BUSY" "DEVICE_PRECONDITION_FAILED" "DEVICE_STORAGE_NOT_ENOUGH" "DEVICE_FATAL_ERROR"
    [Conditional code==FAILED] Error code.
    errorMessage [Conditional code==FAILED] Error message.
    result This field is returned only for settings-import or settings-export request.
    schemaVersion Version of the settings spec schema.
    specVersion Version of the settings spec.
    settings Setting item values where the key is the setting item ID and the value is the setting item value.
    additionalProperties object
    value boolean or number or string
    One of boolean number string
    errors Errors when settings import or export.
    id Setting item id where errors occurred.
    message Error message.
    createdAt Event created time(ISO8601 extended format).
    updatedAt Event updated time(ISO8601 extended format).
    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