21.5.1.1 Response JSON Parameters

This section provides the list of parameters in the JSON response.

Table 21-15 POST JSON Response

Name Type Description
fileName STRING The migration code embedded with .DMP extension. For Example: "TEST_BO_20230921_1234.DMP"
downloadURL STRING This can be fetched from the object store.
errorMessage STRING

Details of the error occurred.

For example: Migration code doesnt exists.

statusCode STRING It indicates the status code of the service. For example: FILE_URL_DOWNLOAD_SUCCESS
status STRING

Status of the migration

  • Success
  • Failed

Table 21-16 Possible Status Codes

Status Code Description
Success:200 Success
Error:400 Invalid inputs
Error:500 Internal Server Error

Response JSON Sample

Success:200

{

    "fileName:":"PublicExport005_BO_203931_676578.DMP

    "downloadURL": <Object store link embedded with File name>

    "errorMessage": "",

    "statusCode": "FILE_URL_DOWNLOAD_SUCCESS",

    "status": "SUCCESS"
     

}

Error: 400

{    

    "errorMessage": "Migration code doesnt exists", 

    "statusCode": "MIGRATION_CODE_DOESNT_EXIST", 

    "status": "FAILED" 

    "downloadURL": ""  

    "fileName:":""

}

Error :500

{

     "statusCode": "INTERNAL_SERVER_ERROR", 

     "errorMessage": "Internal Server Error",

     "statusCode": "FAILED", 

     "status": "FAILED", 

     "downloadURL": "" 

     "fileName:":""

}