Migration REST APIs

The Migration REST APIs aid administrators in the creation, distribution, and deployment of migration packages, migration resources, and migration tasks. Oracle CPQ 25B adds the following Migration Package endpoint:

Migration Package

Copy a Migration Package

Use this endpoint to create a copy of a migration package.

• Endpoint:  /rest/v18/migrationPackages/{id}/actions/copy
• Method:  POST

Oracle CPQ 25B introduces Migration Tasks REST APIs to aid in the creation and administration of migration tasks.

Migration Tasks

Get All Migration Tasks

Use this endpoint to retrieve a list of all migration tasks.

• Endpoint:  /rest/v18/migrationTasks
• Method:  GET

Get Migration Task

Use this endpoint to get migration task details.

• Endpoint:  /rest/v18/migrationTasks/{taskId}
• Method:  GET

Get Migration Task Categories

Use this endpoint to retrieve a list of migration task categories for a specified task.

• Endpoint:  /rest/v18/migrationTasks/{taskId}/categories
• Method:  GET

Get Migration Task Category Details

Use this endpoint to get a list of migration task category details.

• Endpoint:  /rest/v18/migrationTasks/{taskId}/categories/{category}
• Method:  GET

Roll Back a Migration

Use this endpoint to roll back (undo) a migration completed by the specified task.

• Endpoint:  /rest/v18/migrationTasks/{taskId}/actions/rollback
• Method:  POST

Create a Snapshot

Use this endpoint to submit a task to create a snapshot.

• Endpoint:  /rest/v18/migrationTasks/actions/createSnapshot
• Method:  POST

Revert to Snapshot

Use this endpoint to revert to the snapshot created by the specified task.

• Endpoint:  /rest/v18/migrationTasks/{taskId}/actions/revertToSnapshot
• Method:  POST

Steps to Enable

Review the REST service definition in the REST API guides to leverage (available from the Oracle Help Center > your apps service area of interest > APIs & Schema). If you are new to Oracle's REST services you may want to begin with the Quick Start section.

Tips And Considerations

You can cancel or delete migration tasks via the Tasks REST API.