Jump to

• Request
• Response
• Examples

Import Migration Package

post

/rest/v19/migrationPackages/actions/import

This endpoint imports and migrates a previously downloaded package (a ZIP file).

Request

Supported Media Types

• multipart/form-data

Form Parameters

• cleanOtherVersionsOfSamePackage: boolean
  This property allows to clean up the list of packages by removing them 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.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Import Migration Package Task details

Body ()

Root Schema : Task details

Type: object

Title: Task details

Task details

Show Source

• links: array Links to the related objects
  Title: Links to the related objects

  Links to the related objects
• taskId: integer
  Title: Task Id

  Task Id

{
    "type":"object",
    "properties":{
        "taskId":{
            "type":"integer",
            "description":"Task Id",
            "title":"Task Id"
        },
        "links":{
            "type":"array",
            "description":"Links to the related objects",
            "title":"Links to the related objects",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    },
    "title":"Task details",
    "description":"Task details"
}

Nested Schema : Links to the related objects

Type: array

Title: Links to the related objects

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

{
    "type":"array",
    "description":"Links to the related objects",
    "title":"Links to the related objects",
    "items":{
        "$ref":"#/definitions/link"
    }
}

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: URL to the related object

  URL to the related object
• rel: string
  Title: Link Relationship to the current object

  Link Relationship to the current object

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Link Relationship to the current object",
            "title":"Link Relationship to the current object"
        },
        "href":{
            "type":"string",
            "description":"URL to the related object",
            "title":"URL to the related object"
        }
    },
    "title":"reference links",
    "description":"Reference links for the Parent, Self, Children and Related as applicable"
}

Back to Top

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 -H "Authorization: Bearer <token>" --request POST 'https://sitename.oracle.com/rest/v19/migrationPackages/actions/import' \
  \
 \
--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/v19/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/v19/tasks/41372699

Response Body Sample

{
  "id": 41372699,
  "dateModified": "04/15/2020 4:02 PM",
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v19/tasks/41372699"
    }, {
      "rel": "parent",
      "href": "https://sitename.oracle.com/rest/v19/tasks"
    }, {
      "rel": "child",
      "href": "https://sitename.oracle.com/rest/v19/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"
}

Back to Top