1. REST APIs for Accounting Foundation Cloud Service
  2. Object Migration APIs

33 Object Migration APIs

This section provides information on Object migration APIs.

Object Migration is the process of defining, exporting and importing objects across environments (prod and non-prod)/instances. This feature also facilitates to migrate within the same setup or different setups.

Objects refer to the various metadata definitions defined for various domains. You may want to migrate objects for several reasons such as manage global deployments on multiple environments or to create multiple environments so that you can separate the development, testing, and production processes.

For example, you can use the object migration feature to define PMF process object such as balance computation on your testing environment. After successful testing, you can use this feature to export the object to production/non-production environment.

Following are the steps to trigger export/import through public APIs:

Note:

Follow the steps in the below sequence:

The below APIs are for Exporting objects.

  1. Call the Export definition API providing the objects that needs to be exported. The definition of export is persisted against the migration Code.
  2. Use the export migration code and call the Invoke export API.
  3. Call the Export status API to know the status of the triggered export for a given migration code.
  4. Once export is successful, call the Get Download URL API to fetch the file URL for given export DMP file.

    The below APIs are for Importing objects.

  5. Call the Create import definition API and the pass the following parameters "migrationCode", "fileName", "dmpFileURL", "failOnErrorOptions", and "overWriteOptions".
  6. Call the Update import definition API to change run time parameters "failOnErrorOptions", and "overWriteOptions". This is an optional step.
  7. Use the import migration code and call the Invoke Import API.
  8. Call the Import status API to know the status of triggered import for a given migration code.

The following table lists the Request Headers

Table 33-1 Request Headers

Name Type Required Example
ofs_tenant_id STRING Yes r0e17y-prd
locale STRING Yes en-US
ofs_remote_user STRING Yes afcsqa
ofs_workspace_id STRING Yes WS001
ofs_service_id STRING Yes OFS_FSAFND
Content-Type STRING Yes application/json