REST API for Oracle Cloud Infrastructure Process Automation

Migrate All Applications

post

/process/api/v1/oic-migration/jobs

Use this API function to migrate all Oracle Integration Generation 2 applications to Oracle Cloud Infrastructure Process Automation. Start bulk migration from a specified bucket container. For more information see Migrate Process Applications to OCI Process Automation.

Request

There are no request parameters for this operation.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

bucketInfo: object BucketInfo

{
    "type":"object",
    "properties":{
        "bucketInfo":{
            "$ref":"#/components/schemas/BucketInfo"
        }
    }
}

Nested Schema : BucketInfo

Type: object

Show Source

bucket: string
namespace: string
region: string

{
    "type":"object",
    "properties":{
        "region":{
            "type":"string"
        },
        "namespace":{
            "type":"string"
        },
        "bucket":{
            "type":"string"
        }
    }
}

Response

Supported Media Types

application/json

201 Response

Migration started

Root Schema : MigrationJob

Type: object

Show Source

bucketUrl: string
finishedDate: string (date-time)
id: string (uuid)
jobApps: array jobApps
startedDate: string (date-time)
status: string

Allowed Values: [ "NOT_STARTED", "IN_PROGRESS", "SUCCESSFUL", "FAILED" ]

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "bucketUrl":{
            "type":"string"
        },
        "jobApps":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MigrationJobApp"
            }
        },
        "startedDate":{
            "type":"string",
            "format":"date-time"
        },
        "finishedDate":{
            "type":"string",
            "format":"date-time"
        },
        "status":{
            "type":"string",
            "enum":[
                "NOT_STARTED",
                "IN_PROGRESS",
                "SUCCESSFUL",
                "FAILED"
            ]
        }
    }
}

Nested Schema : jobApps

Type: array

Show Source

Array of: object MigrationJobApp

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/MigrationJobApp"
    }
}

Nested Schema : MigrationJobApp

Type: object

Show Source

appUrl: string
id: string (uuid)
migrationId: string (uuid)
name: string
status: string

Allowed Values: [ "NOT_STARTED", "IN_PROGRESS", "SUCCESSFUL", "FAILED" ]
version: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "appUrl":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "enum":[
                "NOT_STARTED",
                "IN_PROGRESS",
                "SUCCESSFUL",
                "FAILED"
            ]
        },
        "migrationId":{
            "type":"string",
            "format":"uuid"
        }
    }
}

500 Response

An internal error occurred.

Examples

The following example shows how to start a bulk migration job by submitting a POST request on the REST resource using cURL. For more information about cURL, see cURL Access. For more information about endpoint URL structure, see Send Requests.

Example: Start a bulk migration job

You have to provide region, namespace, and bucket details.

curl -X 'POST' \
  'https://<OIC URL>/process/api/v1/oic-migration/jobs' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "bucketInfo": {
    "region": "string",
    "namespace": "string",
    "bucket": "string"
  }
}'

Example: Response body of 201 migration started successful response in JSON format

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "bucketUrl": "string",
  "jobApps": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "appUrl": "string",
      "name": "string",
      "version": "string",
      "status": "NOT_STARTED",
      "migrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "startedDate": "2024-08-09T10:12:26.958Z",
  "finishedDate": "2024-08-09T10:12:26.958Z",
  "status": "NOT_STARTED"
}