Migration REST APIs

Overview

Oracle CPQ supports Migration REST API endpoints for migration packages, migration resources, and migration tasks.

The following Oracle CPQ Migration Package REST API endpoints are available in the Integration Catalog and do not require a Service Request on My Oracle Support:

The following Migration Package, Migration Resource, and Migration Tasks endpoints require you to log a Service Request on My Oracle Support to be available in the Oracle CPQ Integration Catalog:

ClosedAuthentication

Oracle CPQ uses HTTP Basic authentication to authenticate REST calls from third-party systems. When making a call to an Oracle CPQ REST API, the third-party system’s REST client must have encrypted Oracle CPQ login credentials in the Header and an Accept Header that both adhere to HTTP Basic authentication standards. The Accept Header must be set to application/schema+json to see the detailed schema of the resource. For more information see the topic Supported REST Headers.

Administration

Note: The Migration REST APIs are only available for users with administrative permissions and access to the Migration feature.

Migration Packages

ClosedGet List of Migration Packages

Get List of Migration Packages GET Method

Description

This endpoint retrieves a list of migration packages.

URI Endpoint

/rest/v18/migrationPackages
Endpoint Parameters

None required

q

 (Optional) Declares a query expression to specify filtering criteria.

fields

(Optional) Specifies a comma-separated list of fields to be included in response.

orderby

 (Optional) Specifies a comma-separated list of pairs to order the response by.

For more information, see Query Specification Syntax.

HTTP Method

GET

Request Body Parameters

None

Response Body Parameters

The REST API returns the following items for each package:

name

 The name of the migration package

description

 The description for the migration package

version

 The version of the migration package

dateRelease

 The date the migration package was released

dateAdded

 The date the migration package was added

dateModified

 The date of the last migration package modification

identifier

 The unique identifier for the migration package

dependencies

 A list of migration package dependencies

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v18/migrationPackages

ClosedResponse Body Sample

ClosedGet Migration Package Properties

Get Migration Package PropertiesGET Method

Description

This endpoint retrieves the properties for the specified migration package.

URI Endpoint

/rest/v18/migrationPackages/{identifier}
Endpoint Parameters

identifier

 The unique identifier for the migration package

fields

 (Optional) Specifies a comma-separated list of fields to be included in response.

HTTP Method

GET

Request Body Parameters

None
Response Body Parameters

name

 The name of the migration package

description

 The description for the migration package

version

 The version of the migration package

dateRelease

 The date the migration package was released

dateAdded

 The date the migration package was added

dateModified

 The date of the last migration package modification

identifier

 The unique identifier for the migration package

dependencies

 A list of migration package dependencies

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v18/migrationPackages/migrationPackage_v2

ClosedResponse Body Sample

{ "name": "Migration Package", "identifier": "migrationPackage_v2", "version": 2, "dateAdded": "2020-04-15T21:01:57.000Z", "dateModified": "2020-04-15T21:01:57.000Z", "dependencies": { "items": [] }, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v18/migrationPackages/migrationPackage_v2" } ] }

ClosedCreate a Migration Package

Create a Migration Package POST method

Description

This endpoint creates a new migration package.

URI Endpoint

/rest/v18/migrationPackages

Endpoint Parameters

None

HTTP Method

POST

Request Body Parameters

name

 (Required) The name of the migration package

description

 (Optional) The description of the migration package

dateRelease

 (Optional) The date, in yyyy-MM-dd format, the migration package was released

contents

 (Optional) A list of migration package contents

dependencies

 (Optional) A list of migration package dependencies

Response Body Parameters

name

 The name of the migration package

identifier

 The unique identifier for the migration package. The identifier is auto-generated based on input package name and version number.

description

 The description of the migration package

version

 The version of the migration package. The default version value is 1.

dateRelease

 The date the migration package was released

dateAdded

 The date the migration package was added

dateModified

 The date of the last migration package modification

dependencies

 A list of migration package dependencies

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v18/migrationPackages

ClosedRequest Body Sample

{ "name": "pkg2", "contents": { "items": [{ "name": "Commerce", "category": "COMMERCE", "children": [{ "name": "Formula", "variableName": "formula", "resourceType": "process" }, { "name": "Test", "variableName": "test", "resourceType": "process", "granular": true, "children": [{ "name": "Move", "variableName": "_action_process_move", "resourceType": "action", "modifiedByUser": "matt", "lastModified": "07/05/2023 11:28 PM" }, { "name": "Email", "variableName": "_action_process_email_print", "resourceType": "action", "modifiedByUser": "matt", "lastModified": "07/05/2023 11:28 PM" }, { "name": "Main", "variableName": "main", "resourceType": "document", "modifiedByUser": "matt", "lastModified": "07/05/2023 11:27 PM" } ] } ] } ] } }

ClosedResponse Body Sample

{ "name": "pkg2", "identifier": "pkg2_v1", "version": 1, "dateAdded": "2023-08-24T09:31:42.000Z", "dateModified": "2023-08-24T09:31:42.000Z", "dependencies": {}, "links": [{ "rel": "self", "href": "http://sitename.oracle.com /rest/v18/migrationPackages/pkg2_v1" }, { "rel": "child", "href": "http://sitename.oracle.com /rest/v18/migrationPackages/pkg2_v1/contents", "name": "contents" } ] }

ClosedUpdate a Migration Package

Update a Migration Package PATCH method

Description

This endpoint updates the migration package properties of an existing migration package. Only specified properties are added or updated using the PATCH method.

URI Endpoint

/rest/v18/migrationPackages/{id}
Endpoint Parameters

id

 The unique identifier for the migration package the user wants to update

HTTP Method

PATCH

Request Body Parameters

description

 (Optional) The description of the migration package

dateRelease

 (Optional) The date the migration package was released

contents

 (Optional) A list of migration package contents

dependencies

 (Optional) A list of migration package dependencies

Response Body Parameters

name

 The name of the migration package

identifier

 The unique identifier for the migration package

description

 The description of the migration package

version

 The version of the migration package

dateRelease

 The date the migration package was released

dateAdded

 The date the migration package was added

dateModified

 The date of the last migration package modification

dependencies

 A list of migration package dependencies

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v18/migrationPackages/pkg2_v1

ClosedRequest Body Sample

{ "name": "pkg2", "contents": { "items": [{ "name": "Commerce", "category": "COMMERCE", "children": [{ "name": "Formula", "variableName": "formula", "resourceType": "process" }, { "name": "Test", "variableName": "test", "resourceType": "process", "granular": true, "children": [{ "name": "Move", "variableName": "_action_process_move", "resourceType": "action", "modifiedByUser": "matt", "lastModified": "07/05/2023 11:28 PM" }, { "name": "Email", "variableName": "_action_process_email_print", "resourceType": "action", "modifiedByUser": "matt", "lastModified": "07/05/2023 11:28 PM" }, { "name": "Main", "variableName": "main", "resourceType": "document", "modifiedByUser": "matt", "lastModified": "07/05/2023 11:27 PM" } ] } ] } ] } }

ClosedResponse Body Sample

{ "name": "pkg2", "identifier": "pkg2_v1", "version": 1, "dateAdded": "2023-08-24T09:31:42.000Z", "dateModified": "2023-08-24T09:31:42.000Z", "dependencies": {}, "links": [{ "rel": "self", "href": "http://sitename.oracle.com /rest/v18/migrationPackages/pkg2_v1" }, { "rel": "child", "href": "http://sitename.oracle.com /rest/v18/migrationPackages/pkg2_v1/contents", "name": "contents" } ] }

ClosedDelete a Migration Package

Delete a Migration Package DELETE method

Description

This endpoint deletes a migration package.

URI Endpoint

/rest/v18/migrationPackages/{id}
Endpoint Parameters

id

 The unique identifier for the migration package

HTTP Method

DELETE

Request Body Parameters

None

Response Body Parameters

HTTP Code 204

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v18/migrationPackages/migrationPackage_v1

ClosedCopy a Migration Package

Copy a Migration Package POST method

Description

This endpoint creates a copy of a migration package.

URI Endpoint

/rest/v18/migrationPackages/{id}/actions/copy
Endpoint Parameters

id

 The unique identifier of the existing package the user wants to create a package from

HTTP Method

POST
Request Body Parameters

name

 The name for the copied migration package

Response Body Parameters

JSON data for the new copy of the migration package.

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v18/migrationPackages/testPackage/actions/copy

ClosedRequest Body Sample

{ "name": "Test Package" }

ClosedResponse Body Sample

{ "name": "Test Package", "identifier": "testPackage_v1", "version": 1, "dateAdded": "2025-02-17T09:21:26.000Z", "dateModified": "2025-02-17T09:21:26.000Z", "owner": "superuser", "lastModifiedUser": "adminuser1", "sourceSiteUrl": "https://sitename.oracle.com", "dependencies": {}, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v18/migrationPackages/testPackage_v1" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v18/migrationPackages/testPackage_v1/contents", "name": "contents" } ], "isImported": false }

ClosedGet All Migration Package Content

Get All Migration Package ContentGET Method

Description

This endpoint retrieves all migration resources included in an existing package.

URI Endpoint

/rest/v18/migrationPackages/{id}/actions/copy
Endpoint Parameters

id

 The unique identifier for the migration package

HTTP Method

GET

Request Body Parameters

None

Response Body Parameters

JSON data containing all migration resource properties

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v18/migrationPackages/test_package/actions/copy

ClosedResponse Body Sample

{ "items": [{ "name": "Configuration", "category": "CONFIGURATION", "children": [{ "name": "Integration", "variableName": "integration", "resourceType": "product_family_configuration" } ] }, { "name": "Commerce", "category": "COMMERCE", "children": [{ "name": "Test", "variableName": "test", "resourceType": "process" } ] } ], "links": [{ "rel": "self", "href": "http://sitename.oracle.com /rest/v18/migrationPackages/migrationPackage_v1/contents" }, { "rel": "parent", "href": "http://sitename.oracle.com /rest/v18/migrationPackages/migrationPackage_v1" } ] }

ClosedGet Migration Package Category Content

Get Migration Package Category ContentGET Method

Description

This endpoint retrieves all migration resources for a specific category included in an existing migration package.

URI Endpoint

/rest/v18/migrationPackages/{id}/contents/{category}
Endpoint Parameters

id

 The unique identifier for the migration package

category

 The category of migration content

HTTP Method

GET

Request Body Parameters

None

Response Body Parameters

JSON data containing the migration package category properties

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v18/migrationPackages/migrationPackage_v1/contents/CONFIGURATION

ClosedResponse Body Sample

{ "name": "Configuration", "category": "CONFIGURATION", "children": [{ "name": "Integration", "variableName": "integration", "resourceType": "product_family_configuration" } ], "links": [{ "rel": "self", "href": "http://sitename.oracle.com /rest/v18/migrationPackages/migrationPackage_v1/contents/CONFIGURATION" } ] }

ClosedGet Migration Package Content Dependencies

Get Migration Package Content DependenciesGET Method

Description

This endpoint retrieves content dependencies for a migration package.

URI Endpoint

/rest/v18/migrationPackages/{id}/contents/dependencies
Endpoint Parameters

id

 The unique identifier for the migration package

HTTP Method

GET

Request Body Parameters

None

Response Body Parameters

JSON data containing the dependencies for a migration package.

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v18/migrationPackages/migrationPackage_v1/contents/dependencies

ClosedResponse Body Sample

{ "items": [{ "name": "Configuration", "category": "CONFIGURATION", "children": [{ "name": "Admin", "variableName": "admin", "resourceType": "product_family_configuration", "resourceTypeLabel": "Configuration", "dependencies": [{ "name": "Admin", "category": "CATALOG", "variableName": "admin", "resourceTypeLabel": "Catalog", "type": "HIGH_LEVEL", "hierarchy": "CATALOG~Admin" } ] } ] }, { "name": "Commerce", "category": "COMMERCE", "children": [{ "name": "Test", "variableName": "test", "resourceType": "process", "resourceTypeLabel": "Commerce", "granular": true, "dependencies": [{ "name": "Float Field 1", "category": "COMMERCE", "variableName": "floatField1", "resourceType": "attribute", "resourceTypeLabel": "Attribute(s)", "type": "LOW_LEVEL", "hierarchy": "test~process/main~document/floatField1~attribute", "hierarchyLabel": "Test/Document(s)/Main/Attribute(s)/Float Field 1", "source": [{ "name": "Copy", "variableName": "_action_process_resubmit", "resourceType": "action", "resourceTypeLabel": "Action(s)", "hierarchyLabel": "Test/Action(s)" } ] } ] } ] }, { "name": "Data Table", "category": "DATA_TABLE", "children": [{ "name": "[Default]", "variableName": "_default", "resourceType": "data_table_folder", "resourceTypeLabel": "Data Table", "children": [{ "name": "Status", "variableName": "Status", "resourceType": "data_table", "resourceTypeLabel": "Data Table", "dependencies": [{ "name": "SOAPSingleKey", "category": "DATA_TABLE", "variableName": "SOAPSingleKey", "resourceTypeLabel": "Data Table", "type": "HIGH_LEVEL", "hierarchy": "DATA_TABLE~SOAP/SOAP~SOAPSingleKey" } ] } ] } ] } ] }

ClosedGet Migration Package Resource Low-level Details

Get Migration Package Resource Low-level DetailsGET Method

Description

This endpoint retrieves low-level details of a migration resource within a specific category of a migration package.

URI Endpoint

/rest/v18/migrationPackages/{id}/contents/{category}/{varName}
Endpoint Parameters

id

 The unique identifier for the migration package

category

 The category of migration content

varName

 The variable name of the resource

HTTP Method

GET

Request Body Parameters

None

Response Body Parameters

JSON data containing the low-level details of a migration resource that is included in an existing package for a specific category. For example, for Commerce process the response contains: document , sub-documents, actions, attributes, etc. included in the migration package.

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v18/migrationPackages/migrationPackage_v1/contents/configuration/admin

ClosedResponse Body Sample

{ "name": "All Product Family", "variableName": "admin", "children": [ { "name": "Bill Country", "variableName": "CRM_BILL_COUNTRY", "resourceType": "attribute", "modifiedByUser": "superuser", "lastModified": "05/15/2019 1:18 PM" }, { "name": "Admin (Product Family)", "variableName": "admin", "resourceType": "product_family", "modifiedByUser": "sam", "lastModified": "03/26/2021 10:04 AM", "children": [ { "name": "Name", "variableName": "_bm_model_name", "resourceType": "attribute", "lastModified": "03/26/2021 10:04 AM" }, { "name": "Line", "variableName": "line", "resourceType": "product_line", "modifiedByUser": "Automation_JET_UserType_FullAccess", "lastModified": "02/21/2018 12:58 PM", "children": [ { "name": "Test Model", "variableName": "model", "resourceType": "model", "modifiedByUser": "Automation_JET_UserType_FullAccess", "lastModified": "06/15/2017 3:04 PM" } ] } ] }, { "name": "All PF Level (Recommendation)", "variableName": "allPFLevel", "resourceType": "rule", "modifiedByUser": "sam", "lastModified": "05/03/2023 10:56 AM" } ], "links": [ { "rel": "self", "href": "http://sitename.oracle.com /rest/v18/migrationPackages/migrationPackage_v1/contents/configuration/admin" } ] }

ClosedUpdate Migration Package Content

Update Migration Package Content PUT method

Description

This endpoint updates all content within a migration package. Using the PUT method replaces the entire package contents with new package contents.

URI Endpoint

/rest/v18/migrationPackages/{id}/contents
Endpoint Parameters

id

 The unique identifier for the migration package

HTTP Method

PUT

Request Body Parameters

items

 The migration package content for update

Response Body Parameters

items

 The migration package content updated

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v18/migrationPackages/pkg2/contents

ClosedRequest Body Sample

{ "name": "pkg2", "contents": { "items": [{ "name": "Commerce", "category": "COMMERCE", "children": [{ "name": "Formula", "variableName": "formula", "resourceType": "process" }, { "name": "Test", "variableName": "test", "resourceType": "process", "granular": true, "children": [{ "name": "Move", "variableName": "_action_process_move", "resourceType": "action", "modifiedByUser": "matt", "lastModified": "07/05/2023 11:28 PM" }, { "name": "Email", "variableName": "_action_process_email_print", "resourceType": "action", "modifiedByUser": "matt", "lastModified": "07/05/2023 11:28 PM" }, { "name": "Main", "variableName": "main", "resourceType": "document", "modifiedByUser": "matt", "lastModified": "07/05/2023 11:27 PM" } ] } ] } ] } }

ClosedResponse Body Sample

{ "name": "pkg2", "identifier": "pkg2_v1", "version": 1, "dateAdded": "2023-08-24T09:31:42.000Z", "dateModified": "2023-08-24T09:31:42.000Z", "dependencies": {}, "links": [{ "rel": "self", "href": "http://sitename.oracle.com /rest/v18/migrationPackages/pkg2_v1" }, { "rel": "child", "href": "http://sitename.oracle.com /rest/v18/migrationPackages/pkg2_v1/contents", "name": "contents" } ] }

ClosedUpdate Migration Package Resource Low-level Details

Update Migration Package Resource Low-level Details PUT method

Description

This endpoint updates low-level details of a migration resource within a specific category of a migration package. Using the PUT method replaces the entire package contents with new package contents.

URI Endpoint

/rest/v18/migrationPackages/{id}/contents/{category}/{varName}
Endpoint Parameters

id

 The unique identifier for the migration package

category

 The category of migration content

variableName

 The variable name of the resource

HTTP Method

PUT
Request Body Parameters

items

 The low-level items for update

checkedAll

 The Boolean value, if true, includes all migratable low-level detail resources

Response Body Parameters

JSON data containing the list of all migration resources saved as part of low-level details.

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v18/migrationPackages/migrationPackage_v1/contents/commerce/test

ClosedRequest Body Sample

{ "items": [{ "variableName": "main", "resourceType": "document", "children": [{ "variableName": "submit", "resourceType": "action" } ] } ] }

ClosedResponse Body Sample

{ "name": "Test", "variableName": "test", "modifiedByUser": "matt", "lastModified": "09/19/2019 12:30 PM", "children": [{ "name": "Main", "variableName": "main", "resourceType": "document", "modifiedByUser": "matt", "lastModified": "09/18/2019 3:07 PM", "children": [{ "name": "Submit", "variableName": "submit", "resourceType": "action", "modifiedByUser": "lisa", "lastModified": "06/06/2019 1:24 PM" } ] } ], "links": [{ "rel": "self", "href": "http://sitename.oracle.com /rest/v18/migrationPackages/migrationPackage_v1/contents/COMMERCE/test" } ] }

ClosedVersion a Migration Package

Version a Migration Package POST method

Description

This endpoint versions an existing migration package. The new version copies the name, properties and all contents of the original version and is given a new higher version number of the existing migration package and a new identifier.

URI Endpoint

/rest/v18/migrationPackages/{id}/actions/newVersion
Endpoint Parameters

id

 The unique identifier for the migration package

HTTP Method

POST

Request Body Parameters

None

Response Body Parameters

name

 The name of the migration package

identifier

 The unique identifier for the migration package

description

 The description of the migration package

version

 The version of the migration package

dateRelease

 The date the migration package was released

dateAdded

 The date the migration package was added

dateModified

 The date of the last migration package modification

dependencies

 A list of migration package dependencies

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v18/migrationPackages/migrationPackage_v10/actions/newVersion

ClosedResponse Body Sample

{ "name": "Migration Package", "identifier": "migrationPackage_v11", "version": 11, "dateAdded": "2023-06-29T05:42:26.000Z", "dateModified": "2023-06-29T05:42:26.000Z", "dependencies": {}, "links": [{ "rel": "self", "href": "http://sitename.oracle.com /rest/v18/migrationPackages/migrationPackage_v11" }, { "rel": "child", "href": "http://sitename.oracle.com /rest/v18/migrationPackages/migrationPackage_v11/contents" } ], }

ClosedMigrate Package

Migrate Package POST method

Description

This endpoint migrates a package that has been uploaded to the server.

URI Endpoint

/rest/v18/migrationPackages/actions/migrate

Endpoint Parameters

None

HTTP Method

POST

Request Body Parameters

uploadPackageIndentifier

 

 (Required) The identifier for the uploaded ZIP file residing on the server. This value is returned from the Upload ZIP file for a Migration Package REST API.

cleanPkgsOfSameName

 (Optional) The boolean value to delete the migration packages from resources having the same name

contents

(Optional) Content to be added to the migration package

  • To migrate all the content of the package, do not enter contents in the payload.

  • To migrate selected content of the package, include the selected content as part of the payload contents. Therefore, the specified contents are migrated and the remaining or unspecified content data is not migrated.

includeSnapshot

 (Optional) The boolean value to indicate whether to create a snapshot

migrationDescription

 (Optional) The migrate package description

sendNoificationTo

 (Optional) The email address to send migrate package status (i.e., success or error message)

targetProcessVarName

 (Optional) The process variable name to perform cross-process migration

Response Body Parameters

taskId

The task identifier associated with the migration job. A task is initiated when you migrate a package. You can view the status of the migration and cancel the migration, if required.

Refer to the Task REST APIs for the following task-related functions: Get List of Tasks, Get Task, Cancel Task, Get Task File List, and Download a Task File.

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v18/migrationPackages/actions/migrate

ClosedRequest Body Sample

{ "uploadedPackageIdentifier": "MigrationPackage_21668616413578", "targetProcessVarName": "", "sendNotificationTo": "lisa.jones@yourcompany.com", "includeSnapshot": false, "cleanPkgsOfSameName": true }

ClosedResponse Body Sample

{ "taskId": 3023444194, "links": [{ "rel": "related", "href": "http://sitename.oracle.com /rest/v18/tasks/3023444194" } ], "messages": { "info": ["There are other migration tasks that are currently running. Your request will be queued."] } }

ClosedUpload ZIP File for a Migration Package

Upload ZIP File for a Migration PackagePOST method

Description

This endpoint uploads a migration package ZIP file to the server.

URI Endpoint

/rest/v18/migrationPackages/actions/uploadPackage

Endpoint Parameters

None

HTTP Method

POST

Request Body Parameters

Multipart/form data

 

Form data, for example:

file - the migration package file to be uploaded
  Response Body Parameters

name

The name of the migration package

identifier

The unique identifier for the migration package

description

 The description of the migration package

version

 The version of the migration package

dateRelease

 The date the migration package was released

dateAdded

 The date the migration package was added

dateModified

The date of the last migration package modification

siteVersion

The version for the site

uploadedPackageIdentifier

The server location of the uploaded ZIP file

crossProcessMigrationEnabled

The Boolean value to indicate if the migration package is elibible for cross-process migration

dependencies

A list of migration package dependencies

uploadStatus

The upload status of the migration package

  • If package is uploaded, the upload status displays SUCCESS

  • If a package of a lower version is uploaded, the PTS task is triggered and the status displays PTS_IN_PROGRESS with a packageTransformationTask field that includes the respective task details.

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v18/migrationPackages/actions/uploadPackage

ClosedResponse Body Sample

{ "name": "MigrationPackage", "identifier": "migrationPackage_v11", "version": 11, "dateModified": "2023-05-27T02:29:48.000Z", "uploadedPackageIdentifer": "MigrationPackage_111665383246705", "siteVersion": "22.3.0", "validCPM": false, "dependencies": {}, "links": [{ "rel": "self", "href": "http://sitename.oracle.com /rest/v18/migrationPackages/TestPackage_111665383246705?retrieveFromPkgZip=true" }, { "rel": "child", "href": "http://sitename.oracle.com /rest/v18/migrationPackages/TestPackage_111665383246705/contents?retrieveFromPkgZip=true" } ] }

ClosedSample CURL command

curl --request POST 'https://sitename.oracle.com /rest/v18/migrationPackages/actions/uploadPackage' \ --header 'Authorization: Basic c3VwZXJ1c2VyOnFhcGFzcw==' \ --header 'Cookie: JSESSIONID=41fdadef842a4b3ba2079846ac05a5a14ee284b2b4fc509eb875!1363400201' \ --form 'file=@/D:/MigrationPackage_2.zip

ClosedExport Migration Package

Export Migration Package POST method

Description

This endpoint exports the specified migration package. Dependencies are included by default, but the request can contain an option to exclude dependencies.

URI Endpoint

/rest/v18/migrationPackages/{identifier}/actions/export
Endpoint Parameters

identifier

 The unique identifier for the migration package

HTTP Method

POST

Request Body Parameters

excludeDependencies

(Optional) This boolean object is used to exclude defined dependencies from the export file.

  • "true" excludes dependencies.
  • "false" (default value) includes dependencies.
Response Body Parameters

taskId

 The task Id associated with the export.

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v18/migrationPackages/migrationPackage_v2/actions/export

ClosedResponse Body Sample

A task is initiated when you export a migration package and the migration package zip file will be associated with the task. After exporting the migration package, you can view the status of the export and download the exported migration package.

Before initiating a migration package download, the Export Migration Package task validates the package content. If the migration package is determined invalid or without contents, the export task is not generated and an error is triggered. This behavior is available from Oracle CPQ 25A and later.

Get Task Example

To view the status of the migration package export initiate the Get Task REST API using the task id from the Export Migration Package REST API response.

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v18/tasks/41372543

ClosedResponse Sample

{ "id": 41372543, "dateModified": "04/15/2020 3:33 PM", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v18/tasks/41372543" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v18/tasks" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v18/tasks/41372543/files" } ], "name": "Migration REST Export", "category": { "lookupCode": "52", "displayValue": "Migration Package Export" }, "status": "Completed", "result": "MigrationPackage_2", "executionTime": "04/15/2020 3:33 PM", "dateAdded": "04/15/2020 3:33 PM" }

After the task has completed, perform the following steps to download the exported migration package:

  1. Get Task File List

    Initiate the Get Task File List REST API using the task id from the Export Migration Package REST API response.

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v18/tasks/41372543/files

ClosedResponse Sample

{ "items": [{ "links": [{ "rel": "related", "href": "https://sitename.oracle.com/rest/v18/tasks/41372543/files/MigrationPackage_2" } ], "name": "MigrationPackage_2", "type": "application/zip" } ], "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v18/tasks/41372543/files" } ] }

  1. Download Task File

    Initiate the Download Task File REST API using the file name from the Get Task File List REST API.

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v18/tasks/41372543/files/MigrationPackage_2

ClosedImport Migration Package

Import Migration Package POST method

Description

This endpoint imports and applies a migration package. Specify the file to import in the request body. The request can also contain a description, target process variable name, a notification email address, an option to include a snapshot, and the option to delete other versions of the package.

URI Endpoint

/rest/v18/migrationPackages/actions/import

Endpoint Parameters

 None

HTTP Method

POST
Request Header Content-Type: multipart/form-data

Request Body For Data Parameters

file

 The file to be imported (required).

migrationDescription

 (Optional) The description of the migration package being imported

sendNotificationTo

 (Optional) Email address to send notification to

includeSnapshot

(Optional) Set this boolean parameter to 'true' to create a snapshot for this migration package import.

The default value is 'false'.

Due to the amount of data that is recorded and stored within a snapshot, migrations that include snapshots will take longer to complete than migrations that do not include snapshots.

targetProcessVarName

 (Optional) Target Process Variable Name for Cross Process migration.

cleanOtherVersionsOfSamePackage

(Optional) Set this boolean parameter to 'true' to remove other versions of the migration package after a successful migration.

The default value is 'false'.
Response Body Parameters

taskId

 The status log task Id the associated with the import.

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v18/migrationPackages/actions/import

ClosedRequest Body Sample

--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'

ClosedResponse Body Sample

{ "taskId": 41372699, "links": [{ "rel": "related", "href": "https://sitename.oracle.com/rest/v18/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.

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v18/tasks/41372699

ClosedResponse Body Sample

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

To cancel the migration package import initiate the Cancel Task REST API using the task id from the Import Migration Package REST API response.

Migration Resources

ClosedGet All Migration Resources

Get All Migration Resources GET Method

Description

This endpoint retrieves all the migration resources, grouped by category.

URI Endpoint

/rest/v18/migrationResources

Endpoint Parameters

None

HTTP Method

GET

Request Body Parameters

None

Response Body Parameters

JSON data containing all migration resources

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v18/migrationResources

ClosedResponse Body Sample

{ "items": [{ "name": "Util Library", "category": "UTIL_LIBRARY", "children": [{ "name": "", "variableName": "template_1", "resourceType": "library", "granular": true, "links": [{ "rel": "related", "href": "http://sitename.oracle.com /rest/v18/migrationResources/UTIL_LIBRARY/template_1" } ] } ] }, { "name": "Product Definition", "category": "PRODUCT_DEFINITION", "children": [{ "name": "Vision Vehicles", "variableName": "visionVehicles", "resourceType": "product_family" } ] }, { "name": "Catalog", "category": "CATALOG", "children": [{ "name": "Admin", "variableName": "admin", "resourceType": "product_line_model" } ] }, { "name": "Configuration", "category": "CONFIGURATION", "children": [{ "name": "Admin", "variableName": "admin", "resourceType": "product_family_configuration", "granular": true, "links": [{ "rel": "related", "href": "http://sitename.oracle.com /rest/v18/migrationResources/CONFIGURATION/admin" } ] } ] } ], "links": [{ "rel": "self", "href": "http://sitename.oracle.com /rest/v18/migrationResources" } ] }

ClosedGet Category Migration Resources

Get Category Migration ResourcesGET Method

Description

This endpoint retrieves all migration resources for a specific category.

URI Endpoint

/rest/v18/migrationResources/{category}
Endpoint Parameters

category

 The category of migration content. Include to filter by resource category

HTTP Method

GET

Request Body Parameters

None

Response Body Parameters

JSON data containing the list of migration resources

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v18/migrationResources/UTIL_LIBRARY

ClosedResponse Body Sample

{ "items": [{ "name": "Util Library", "category": "UTIL_LIBRARY", "children": [{ "name": "RecommendationRule_StringArrayAttribute", "variableName": "recommendationRule_StringArrayAttribute", "resourceType": "library", "links": [{ "rel": "related", "href": "http:// https://sitename.oracle.com/rest/v18/migrationResources/UTIL_LIBRARY/recommendationRule_StringArrayAttribute" } ] }, { "name": "TranslatedLanguage", "variableName": "translatedLanguage", "resourceType": "library", "links": [{ "rel": "related", "href": "http:// https://sitename.oracle.com/rest/v18/migrationResources/UTIL_LIBRARY/translatedLanguage" } ] } ] } ] }

ClosedGet Category Resource Low-level Details

Get Category Resource Low-level DetailsGET Method

Description

This endpoint retrieves low-level details of a migration resource within a specific category.

URI Endpoint

/rest/v18/migrationResources/{category}/{varName}
Endpoint Parameters

category

 The category of migration content. Include to filter by resource category.

varName

 The variable name of the category item. Include to filter by resource category and variable name.

HTTP Method

GET

Request Body Parameters

None

Response Body Parameters

JSON data containing the low-level details of a migration resource for a specific category. For example, for Commerce process the response contains: document , sub-documents, actions, attributes, etc.

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v18/migrationResources/COMMERCE/test

ClosedResponse Body Sample

{ "name": "Test", "variableName": "test", "modifiedByUser": "matt", "lastModified": "09/19/2019 12:30 PM", "children": [{ "name": "Export File Attachments", "variableName": "_action_export_file_attachments", "resourceType": "action", "modifiedByUser": "matt", "lastModified": "12/15/2017 3:25 PM" }, { "name": "Main", "variableName": "main", "resourceType": "document", "modifiedByUser": "matt", "lastModified": "09/18/2019 3:07 PM", "children": [{ "name": "SSM 1", "variableName": "sSM1", "resourceType": "attribute", "modifiedByUser": "matt", "lastModified": "09/17/2019 9:11 AM" }, { "name": "submit", "variableName": "submit", "resourceType": "action", "lastModified": "01/05/2023 9:55 AM" }, { "name": "Hide AJAX Output Sub", "variableName": "hideAJAXOutputSub", "resourceType": "rule", "modifiedByUser": "matt", "lastModified": "09/17/2019 1:19 PM" } ] }, { "name": "formulaOutput = formulaInput", "variableName": "formulaOutput = formulaInput", "resourceType": "formula", "modifiedByUser": "matt", "lastModified": "09/17/2019 12:44 PM" }, { "name": "To Step 2 Step", "variableName": "toStep2", "resourceType": "step", "lastModified": "12/15/2017 3:25 PM" }, { "name": "Document PDF(Printer Friendly/History)", "variableName": "documentPDF", "resourceType": "xsl_view", "modifiedByUser": "matt", "lastModified": "12/15/2017 3:25 PM" } ], "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v18/migrationResources/COMMERCE/test" } ] }

ClosedGet Dependencies for Selected Migration Resources or Migration Package from Source Site

Get Dependencies for Selected Migration Resources or Migration Package from Source Site POST method

Description

This endpoint retrieves the dependencies for migration resources or a migration package from a source site.

URI Endpoint

/rest/v18/migrationResources/dependencies

Endpoint Parameters

None

HTTP Method

POST
Request Header

siteURL

 (Required) The URL for the source site

username

 (Required) The username for the source site

password

 (Required) The password for the source site

Request Body Parameters

packageIdentifier

 (Required for Migration Package) The identifier for the migration package residing in the source site

contents

(Required for Migration Resources and Optional for Migration Package) Content with dependencies

  • To get dependencies for all package content, do not specify contents in the payload.

  • To get dependencies for selected migration resources, include the selected content as part of the payload contents. The dependencies are calculated for the specified content.

hierarchyLabel

 Resource property information

Response Body Parameters

 JSON data containing the dependencies for the migration resources or the migration package from a source site.

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v18/migrationResources/dependencies

Example of Dependencies of Selected Migration Resources from a Source Site

ClosedRequest Body Sample

{ "contents": { "items": [{ "category": "COMMERCE", "children": [{ "name": "test", "variableName": "test", "granular": true, "children": [{ "variableName": "test", "resourceType": "process", "checked": false, "children": [{ "name": "Main", "variableName": "main", "resourceType": "document", "children": [{ "name": "Save", "variableName": "save", "resourceType": "action", "modifiedByUser": "adminuser1", "lastModified": "08/01/2023 10:28 PM" }, { "name": "Submit", "variableName": "submit", "resourceType": "action", "modifiedByUser": "adminuser1", "lastModified": "08/01/2023 10:27 PM" } ] } ] } ] } ] } ] } }

ClosedResponse Body Sample

{ "items": [{ "name": "Commerce", "category": "COMMERCE", "children": [{ "name": "Test", "variableName": "test", "resourceType": "process", "resourceTypeLabel": "Commerce", "granular": true, "dependencies": [{ "name": "Step Name", "category": "COMMERCE", "variableName": "stepName", "resourceType": "attribute", "resourceTypeLabel": "Attribute(s)", "type": "LOW_LEVEL", "hierarchy": "test~process/main~document/stepName~attribute", "hierarchyLabel": "Test/Document(s)/Main/Attribute(s)/Step Name", "source": [{ "name": "Save", "variableName": "save", "resourceType": "action", "resourceTypeLabel": "Action(s)", "hierarchyLabel": "Test/Document(s)/Main/Action(s)" } ] }, { "name": "HTML Field 1", "category": "COMMERCE", "variableName": "hTMLField1", "resourceType": "attribute", "resourceTypeLabel": "Attribute(s)", "type": "LOW_LEVEL", "hierarchy": "test~process/main~document/hTMLField1~attribute", "hierarchyLabel": "Test/Document(s)/Main/Attribute(s)/HTML Field 1", "source": [{ "name": "Save", "variableName": "save", "resourceType": "action", "resourceTypeLabel": "Action(s)", "hierarchyLabel": "Test/Document(s)/Main/Action(s)" }, { "name": "Submit", "variableName": "submit", "resourceType": "action", "resourceTypeLabel": "Action(s)", "hierarchyLabel": "Test/Document(s)/Main/Action(s)" } ] } ] } ] } ] }

Example of Dependencies of a Migration Package from a Source Site

ClosedRequest Body Sample

{ "packageIdentifier": "migrationPackage_v1", "contents": { "items": [{ "category": "COMMERCE", "children": [{ "name": "test", "variableName": "test", "granular": true, "children": [{ "variableName": "test", "resourceType": "process", "checked": false, "children": [{ "name": "Main", "variableName": "main", "resourceType": "document", "children": [{ "name": "Save", "variableName": "save", "resourceType": "action", "modifiedByUser": "adminuser1", "lastModified": "08/01/2023 10:28 PM" }, { "name": "Submit", "variableName": "submit", "resourceType": "action", "modifiedByUser": "adminuser1", "lastModified": "08/01/2023 10:27 PM" } ] } ] } ] } ] } ] } }

ClosedResponse Body Sample

{ "items": [{ "name": "Commerce", "category": "COMMERCE", "children": [{ "name": "Test", "variableName": "test", "resourceType": "process", "resourceTypeLabel": "Commerce", "granular": true, "dependencies": [{ "name": "Step Name", "category": "COMMERCE", "variableName": "stepName", "resourceType": "attribute", "resourceTypeLabel": "Attribute(s)", "type": "LOW_LEVEL", "hierarchy": "test~process/main~document/stepName~attribute", "hierarchyLabel": "Test/Document(s)/Main/Attribute(s)/Step Name", "source": [{ "name": "Save", "variableName": "save", "resourceType": "action", "resourceTypeLabel": "Action(s)", "hierarchyLabel": "Test/Document(s)/Main/Action(s)" } ] }, { "name": "HTML Field 1", "category": "COMMERCE", "variableName": "hTMLField1", "resourceType": "attribute", "resourceTypeLabel": "Attribute(s)", "type": "LOW_LEVEL", "hierarchy": "test~process/main~document/hTMLField1~attribute", "hierarchyLabel": "Test/Document(s)/Main/Attribute(s)/HTML Field 1", "source": [{ "name": "Save", "variableName": "save", "resourceType": "action", "resourceTypeLabel": "Action(s)", "hierarchyLabel": "Test/Document(s)/Main/Action(s)" }, { "name": "Submit", "variableName": "submit", "resourceType": "action", "resourceTypeLabel": "Action(s)", "hierarchyLabel": "Test/Document(s)/Main/Action(s)" } ] } ] } ] } ] }

ClosedMigrate Selected Migration Resources or Migration Package from Source Site

Migrate Selected Migration Resources or Migration Package from Source Site POST method

Description

This endpoint migrates the selected migration resources or a migration package from a source site.

URI Endpoint

/rest/v18/migrationResources/actions/migrate

Endpoint Parameters

None

HTTP Method

POST
Request Header

siteURL

 (Required) The URL for the source site

username

 (Required) The username for the source site

password

 (Required) The password for the source site

Request Body Parameters

packageIdentifier

 (Required for Migration Package) The identifier for the migration package residing in the source site

cleanPkgsOfSameName

 (Required for Migration Package and Optional for Migration Resources) The boolean value to delete the migration packages from resources having the same name

contents

(Required for Migration Resources and Optional for Migration Package) Content to be migrated

  • To migrate all package content, do not enter contents in the payload.

  • To migrate selected migration resources or package content, include the selected content as part of the payload contents. Therefore, the specified contents are migrated and the remaining or unspecified content data is not migrated.

excludeContents

 (Optional) The migration package content to exclude from the migration. The specified excludeContents are not migrated with the package.

includeSnapshot

 (Optional) The boolean value to indicate whether to create a snapshot

migrationDescription

 (Optional) The migrate resource or migrate package description

sendNotificationTo

 (Optional) The email address to send migrate status (i.e., success or error message)e

dependencies

 (Optional) A list of migration resources or migration package dependencies
Response Body Parameters

taskId

The task identifier associated with the migration job. A task is initiated when you migrate resources or a package. You can view the status of the migration and cancel the migration, if required.

Refer to the Task REST APIs for the following task-related functions: Get List of Tasks, Get Task, Cancel Task, Get Task File List, and Download a Task File.

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v18/migrationResources/actions/migrate

Example of Migrating Resources from a Source Site

ClosedRequest Body Sample

{ "contents": { "items": [{ "category": "COMMERCE", "children": [{ "variableName": "test", "granular": true, "children": [{ "variableName": "main", "resourceType": "document", "checkedAllChildren": false, "children": [{ "name": "eSignature Action Set", "variableName": "_action_esig_set", "resourceType": "action_set", "lastModified": "06/15/2023 3:27 AM" } ] } ] } ] } ] } }

ClosedResponse Body Sample

{ "taskId": 3023163957, "links": [{ "rel": "related", "href": "http://sitename.oracle.com /rest/v18/tasks/3023163957" } ] }

Example of Migrating a Package from a Source Site

ClosedRequest Body Sample

{ "packageIdentifier": "packageName3_v1", "sendNotificationTo": "lisajones@yourcompany.com", "includeSnapshot": false, "excludeContents": { "items": [{ "category": "COMMERCE", "children": [{ "variableName": "test", "granular": true, "children": [{ "variableName": "main", "resourceType": "document", "checkedAllChildren": false, "children": [{ "name": "eSignature Action Set", "variableName": "_action_esig_set", "resourceType": "action_set", "lastModified": "06/15/2023 3:27 AM" } ] } ] } ] } ] }, "dependencies": { "items": [{ "name": "Commerce", "category": "COMMERCE", "children": [{ "name": "Test", "variableName": "test", "resourceType": "process", "granular": true, "dependencies": [{ "name": "HTML Field 1", "category": "COMMERCE", "variableName": "hTMLField1", "resourceType": "attribute", "type": "LOW_LEVEL", "hierarchy": "test~process/main~document/hTMLField1~attribute" } ] } ] } ] } }

ClosedResponse Body Sample

{ "taskId": 3023163957, "links": [{ "rel": "related", "href": "http://sitename.oracle.com /rest/v18/tasks/3023163957" } ] }

Migration Tasks

ClosedGet All Migration Tasks

Get All Migration TasksGET Method

Description

This endpoint retrieves a list of all migration tasks.

URI Endpoint

/rest/v18/migrationTasks
Endpoint Parameters

This endpoint supports the following query specifications. For more information, see Manage Collections.

  • expand - Expands the child content.

  • limit – Specifies the pagination size to limit the number of elements the collection returns at a maximum.

  • offset – The offset of the page. By default, offset is 0, which means first page will be returned.

  • orderby – Specifies a comma-separated list of fields to order the response by.

  • totalResults - Specifies that the total count of records that should be included in the response when doing pagination. Only effective when limit or offset are specified.

HTTP Method

GET

Request Body Parameters

None

Response Body Parameters

JSON data containing all migration tasks.

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v18/migrationTasks

ClosedResponse Body Sample

{ "items": [{ "taskId": 3023634117, "owner": "adminuser1", "taskCategory": { "value": 22, "displayValue": "Snapshot" }, "status": "Snapshot Cancelled", "statusLabel": "Snapshot Cancelled", "date": "2025-02-14T05:27:40.000Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v18/migrationTasks/3023634117" } ], "isRevertToSnapshot": false, "isDownload": false, "isDelete": false, "isRollback": false, "isCancel": false }, { "taskId": 3023628792, "owner": "adminuser1", "taskCategory": { "value": 33, "displayValue": "Rollback of a migration" }, "description": "Rollback for migration dated 02/12/2025 6:41 AM", "status": "Successful", "statusLabel": "Successful", "date": "2025-02-14T05:40:07.250Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v18/migrationTasks/3023628792" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v18/migrationTasks/3023628792/categories" } ], "isRevertToSnapshot": false, "isDownload": false, "isDelete": true, "isRollback": false, "isCancel": false }, { "taskId": 3023628791, "owner": "adminuser1", "taskCategory": { "value": 32, "displayValue": "Migration Rollback Helper" }, "description": "User Initiated Rollback", "status": "Successful", "statusLabel": "Successful", "date": "2025-02-14T05:25:18.000Z", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v18/migrationTasks/3023628791"

} ], "isRevertToSnapshot": false, "isDownload": false, "isDelete": true, "isRollback": false, "isCancel": false } ] }

ClosedGet Migration Task

Get Migration TaskGET Method

Description

This endpoint retrieves migration task details.

URI Endpoint

/rest/v18/migrationTasks/{taskId}
Endpoint Parameters

taskId

 The unique task identifier.

expand

(Optional) This endpoint supports the expand query specification to expand the child content.

HTTP Method

GET

Request Body Parameters

None

Response Body Parameters

JSON data containing the specified migration task.

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v18/migrationTasks/3023616692

ClosedResponse Body Sample

{ "taskId": 3023616692, "owner": "adminuser1", "taskCategory": { "value": 19, "displayValue": "Migrate" }, "status": "Failed", "statusLabel": "Failed", "date": "2025-02-12T14:41:23.738Z", "statusMessage": "One of the object in package ABO_RefApp_Package_24D failed to migrate.", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v18/migrationTasks/3023616692" }, { "rel": "child", "href": "https://sitename.oracle.com/rest/v18/migrationTasks/3023616692/categories" } ], "isRevertToSnapshot": false, "isDownload": false, "isDelete": true, "isRollback": false, "isCancel": false }

ClosedGet Migration Task Categories

Get Migration Task CategoriesGET Method

Description

This endpoint retrieves a list of migration task categories for a specified task.

URI Endpoint

/rest/v18/migrationTasks/{taskId}/categories
Endpoint Parameters

taskId

 The unique task identifier.

expand

(Optional) This endpoint supports the expand query specification to expand the child content.

HTTP Method

GET

Request Body Parameters

None

Response Body Parameters

JSON data containing the specified migration task categories.

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v18/migrationTasks/3023616692/categories

ClosedResponse Body Sample

{ "items": [{ "category": "FILE_MANAGER", "categoryLabel": "File Manager", "date": "2025-02-12T14:31:58.344Z", "status": "Successful", "statusLabel": "Successful", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v18/migrationTasks/3023616692/categories/FILE_MANAGER" } ] }, { "category": "COMMERCE", "categoryLabel": "Commerce", "date": "2025-02-12T14:32:04.359Z", "status": "Successful", "statusLabel": "Successful", "statusMessage": "Warning occurred during the migration. Please see the logs for more details.", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v18/migrationTasks/3023616692/categories/COMMERCE" } ] }, { "category": "UTIL_LIBRARY", "categoryLabel": "Util Library", "date": "2025-02-12T14:32:58.887Z", "status": "Successful", "statusLabel": "Successful", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v18/migrationTasks/3023616692/categories/UTIL_LIBRARY" } ] }, { "category": "PACKAGE", "categoryLabel": "Package", "date": "2025-02-12T14:41:23.738Z", "status": "Successful", "statusLabel": "Successful", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v18/migrationTasks/3023616692/categories/PACKAGE" } ] } ], "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v18/migrationTasks/3023616692/categories" } ] }

ClosedGet Migration Task Category Details

Get Migration Task Category DetailsGET Method

Description

This endpoint retrieves a list of migration task category details.

URI Endpoint

/rest/v18/migrationTasks/{taskId}/categories/{category}
Endpoint Parameters

taskId

 The unique task identifier.

category

 The unique category identifier.

expand

(Optional) This endpoint supports the expand query specification to expand the child content.

HTTP Method

GET

Request Body Parameters

None

Response Body Parameters

JSON data containing the specified migration task category detail.

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v18/migrationTasks/3023616692/categories/file_manager

ClosedResponse Body Sample

{ "category": "FILE_MANAGER", "categoryLabel": "File Manager", "events": [{ "name": "Begin Upload", "timeStamp": "2025-02-12T14:31:58.344Z", "status": "Successful", "statusLabel": "Successful" }, { "name": "Complete", "timeStamp": "2025-02-12T14:32:03.000Z", "status": "Successful", "statusLabel": "Successful" } ], "logs": [{ "displayName": "ABO/defaultContextJson.txt", "items": [{ "level": "INFO", "levelLabel": "Info", "message": "Starting the migration process.", "timeStamp": "2025-02-12T14:32:02.778Z" }, { "level": "INFO", "levelLabel": "Info", "message": "Starting to save data to database.", "timeStamp": "2025-02-12T14:32:02.831Z" }, { "level": "INFO", "levelLabel": "Info", "message": "Completed saving data to database.", "timeStamp": "2025-02-12T14:32:02.855Z" }, { "level": "INFO", "levelLabel": "Info", "message": "Completed the migration process.", "timeStamp": "2025-02-12T14:32:02.935Z" } ] }, { "displayName": "Bulk Processor for File Manager", "items": [{ "level": "INFO", "levelLabel": "Info", "message": "Starting the migration process.", "timeStamp": "2025-02-12T14:32:02.935Z" }, { "level": "INFO", "levelLabel": "Info", "message": "Completed the migration process.", "timeStamp": "2025-02-12T14:32:02.936Z" } ] } ] }

ClosedRoll Back a Migration

Roll Back a MigrationPOST method

Description

This endpoint is used to roll back (undo) a migration completed by the specified task.

URI Endpoint

/rest/v18/migrationTasks/{taskId}/actions/rollback
Endpoint Parameters

taskId

 The unique task identifier.

HTTP Method

POST

Request Body Parameters

None

Response Body Parameters

JSON data containing the specified migration task and links.

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v18/migrationTasks/3023660980/actions/rollback

ClosedResponse Body Sample

{ "taskId": 3023660980, "links": [{ "rel": "related", "href": "https://sitename.oracle.com/rest/v18/migrationTasks/3023660980" } ] }

ClosedCreate a Snapshot

Create a SnapshotPOST method

Description

This endpoint submits a task to create a snapshot.

URI Endpoint

/rest/v18/migrationTasks/actions/createSnapshot
Endpoint Parameters None

HTTP Method

POST

Request Body Parameters

None

Response Body Parameters

JSON data containing the migration snapshot task details.

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v18/migrationTasks/actions/createSnapshot

ClosedResponse Body Sample

{ "taskId": 3023660644, "links": [{ "rel": "related", "href": "https://sitename.oracle.com/rest/v18/migrationTasks/3023660644" } ] }

ClosedRevert to Snapshot

Revert to SnapshotPOST method

Description

This endpoint reverts to the snapshot created by the specified task.

URI Endpoint

/rest/v18/migrationTasks/{taskId}/actions/revertToSnapshot
Endpoint Parameters

taskId

 The unique task identifier.

HTTP Method

POST

Request Body Parameters

None

Response Body Parameters

JSON data containing the migration revert to snapshot task details.

ClosedURI Endpoint Sample

https://sitename.oracle.com/rest/v18/migrationTasks/3023660703/actions/revertToSnapshot

ClosedResponse Body Sample

{ "taskId": 3023660703, "links": [{ "rel": "related", "href": "https://sitename.oracle.com/rest/v18/migrationTasks/3023660703" } ] }

 

Refer to the Task REST APIs to cancel or delete migration tasks.

Related Topics

Related Topics Link IconSee Also