return-data-box
    • PDF

    return-data-box

    • PDF

    Article summary

    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 nameRequirement statusTypeRestrictionsDescription
    dataBoxFrameNoYesIntegerData Box Frame number
    dataBoxFrameYesIntegerData Box number

    Responses

    HTTP status codeDescription
    200Success
    400Request information error
    401Authentication failed
    403No permission to request information
    404Resource not found
    500Server error

    Examples

    Request examples

    {
      "dataBoxFrameNo": 1046,
      "dataBoxNo": 192
    }
    

    Response examples

     {
      "returnMessage" : "A Data Box return has been requested."
    }
    

    Errors

    HTTP Status CodeReturn codeDescription
    200-Successful normal request
    40010001,
    130***
    Request information and parameter error
    40310002No permission to request information
    40410009Resource not found
    500130000Service internal error
    500139999Integration service API call error

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.