Transport Status

GET 
/transportPackageStatus

This API obtains the status of the transport request (import, export, or transfer), and helps in confirming whether the transport was completed successfully or failed.

Note: This API returns the status of only those requests that have been processed using the Enhanced Transport feature.

The Authorization must have Bearer followed by Token.

Mandatory params:

operation - enter the type of transport request (export, import, or transfer)
filename - enter the transport package zip file name in full (including the .zip extension)
requestid(required only if the operation is import) - enter the request ID generated during the submission of the import request

Request

application/json

Body

filename string
operation string

Responses

200

Transport Status - Blank Request ID / Transport Status - Import / Transport Status - Export

Response Headers

• Cache-Control

  string

• Connection

  string

• Date

  string

• Set-Cookie

  string

• Strict-Transport-Security

  string

• Transfer-Encoding

  string

• Vary

  string

• X-Content-Type-Options

  string

• X-Frame-Options

  string

• X-XSS-Protection

  string

application/json

Schema

Schema

errorCode number
msg string
msgDescription string

Example (from schema)

{
  "errorCode": 1,
  "msg": "Invalid request Payload",
  "msgDescription": "Requestid cannot be blank"
}

Transport Status - Blank Request ID

{
  "errorCode": 1,
  "msg": "Invalid request Payload",
  "msgDescription": "Requestid cannot be blank"
}

Transport Status - Export

{
  "errorCode": 0,
  "msg": "Success",
  "msgDescription": "The environment package was successfully exported."
}

Transport Status - Import

{
  "errorCode": 0,
  "msg": "Success",
  "msgDescription": "The environment package was successfully imported."
}

Loading...