Import Migration Package
post
/rest/v16/migrationPackages/actions/import
Use this endpoint to import and migrate a previously downloaded package (a ZIP file).
Request
Supported Media Types
- multipart/form-data
Form Parameters
-
cleanOtherVersionsOfSamePackage: boolean
Set this boolean parameter to 'true' to remove other versions of the migration package after a successful migration.
-
file(required): file
Package file to be imported
-
includeSnapshot: boolean
Include Snapshot
-
migrationDescription: string
The description of the migration package being imported
-
sendNotificationTo: string
Send Email Notification to
-
targetProcessVarName: string
Target Process Variable Name for Cross Process migration
Response
Supported Media Types
- application/json
Default Response
Import Migration Package Task details
Root Schema : Task details
Type:
object
Title:
Task details
Task details
Show Source
-
links:
array Links
Title:
Links
Links to the related objects. -
taskId:
integer
Title:
Task Id
The status log task Id.
Nested Schema : Links
Type:
array
Title:
Links
Links to the related objects.
Show Source
-
Array of:
object Reference Links
Title:
Reference Links
Reference links for the Parent, Self, Children and Related as applicable
Nested Schema : Reference Links
Type:
object
Title:
Reference Links
Reference links for the Parent, Self, Children and Related as applicable
Show Source
-
href:
string
Title:
href
URL to the related object -
rel:
string
Title:
Link
Link relationship to the current object
Examples
The following example shows how to import data tables by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.
curl --request POST 'https://sitename.oracle.com/rest/v16/migrationPackages/actions/import' \ --header 'Authorization: Basic c3VwZXJ1c2VyOnFhcGFzcw==' \ --header 'Cookie: JSESSIONID=41fdadef842a4b3ba2079846ac05a5a14ee284b2b4fc509eb875!1363400201' \ --form 'file=@/D:/MigrationPackage_2.zip' \ --form 'migrationDescription=This migration package contains...' \ --form 'sendNotificationTo=<username>@<domain>.com' \ --form 'includeSnapshot=true' \ --form 'targetProcessVarName=oraclecpqo_bmClone_1' \ --form 'cleanOtherVersionsOfSamePackage=true'
Response Body Sample
{ "taskId": 41372699, "links": [{ "rel": "related", "href": "https://sitename.oracle.com/rest/v16/tasks/41372699" } ] }
A task is initiated when you import a migration package. After importing the migration package, you can view the status of the import and cancel the migration package, if required.
Get Task Example
To view the status of the migration package import initiate the Get Task REST API using the task id from the Import Migration Package REST API response.
URI Endpoint Sample
https://sitename.oracle.com/rest/v16/tasks/41372699
Response Body Sample
{ "id": 41372699, "dateModified": "04/15/2020 4:02 PM", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/tasks/41372699" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v16/tasks" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v16/tasks/41372699/files" } ], "name": "Migration REST Import", "category": { "lookupCode": "51", "displayValue": "Migration Package Import" }, "status": "Completed", "detailStatus": { "message": "Task is completed successfully.", "items": [{ "entity": "Util Library", "status": "Successful" }, { "entity": "Package", "status": "Successful" } ] }, "executionTime": "04/15/2020 4:00 PM", "dateAdded": "04/15/2020 4:00 PM" }