return-data-box
- Print
- PDF
return-data-box
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
It requests a return of Data Box.
- It takes time to create/return/change the infrastructure and operates asynchronously.
- If the request was sent successfully, a fixed message is returned.
POST https://{endpoint}/data-box/return-data-box
Requests
Request parameters
| Parameter name | Requirement status | Type | Restrictions | Description |
|---|---|---|---|---|
| dataBoxFrameNo | Yes | Integer | Data Box Frame number | |
| dataBoxFrame | Yes | Integer | Data Box number |
Responses
| HTTP status code | Description |
|---|---|
| 200 | Success |
| 400 | Request information error |
| 401 | Authentication failed |
| 403 | No permission to request information |
| 404 | Resource not found |
| 500 | Server error |
Examples
Request examples
{
"dataBoxFrameNo": 1046,
"dataBoxNo": 192
}
Response examples
{
"returnMessage" : "A Data Box return has been requested."
}
Errors
| HTTP Status Code | Return code | Description |
|---|---|---|
| 200 | - | Successful normal request |
| 400 | 10001, 130*** | Request information and parameter error |
| 403 | 10002 | No permission to request information |
| 404 | 10009 | Resource not found |
| 500 | 130000 | Service internal error |
| 500 | 139999 | Integration service API call error |
Was this article helpful?