REST API for Oracle Cloud Infrastructure Process Automation

Get Migration Report of Application

get

/process/api/v1/oic-migration/migrations/{migrationId}

Get a migration report for an application that is being migrated from Oracle Integration Generation 2 to Oracle Cloud Infrastructure Process Automation.

Request

Path Parameters

migrationId(required): string

Migration id

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Migration report found

Root Schema : RestMigration

Type: object

Show Source

id: string (uuid)
migratedBy: string
migratedOn: string (date-time)
originalProjectName: string
projectId: string (uuid)

Default Value: oracle.doceng.json.BetterJsonNull@7e15f4d4
projectName: string
projectType: string

Default Value: PROJECT

Allowed Values: [ "PROJECT", "DMN_APPLICATION" ]
report: object RestReport
result: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "projectId":{
            "type":"string",
            "format":"uuid",
            "default":null
        },
        "projectName":{
            "type":"string"
        },
        "projectType":{
            "type":"string",
            "default":"PROJECT",
            "enum":[
                "PROJECT",
                "DMN_APPLICATION"
            ]
        },
        "originalProjectName":{
            "type":"string"
        },
        "migratedBy":{
            "type":"string"
        },
        "migratedOn":{
            "type":"string",
            "format":"date-time"
        },
        "result":{
            "type":"string"
        },
        "report":{
            "$ref":"#/components/schemas/RestReport"
        }
    }
}

Nested Schema : RestReport

Type: object

Show Source

id: string (uuid)
remarks: array remarks

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "remarks":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RestRemark"
            }
        }
    }
}

Nested Schema : remarks

Type: array

Show Source

Array of: object RestRemark

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

Nested Schema : RestRemark

Type: object

Show Source

artifactId: string (uuid)
artifactName: string (uuid)
artifactType: string

Allowed Values: [ "PROJECT", "FORM", "STYLESHEET", "DYNAMIC_PROCESS", "STRUCTURED_PROCESS", "CONNECTOR", "ROLE", "EXTERNAL_UI", "DMN_DIAGRAM", "DMN", "MAPPING_ACTION", "CUSTOM_BUSINESS_OBJECT", "BUSINESS_EXCEPTION", "LOCALE" ]
remark: string
type: string

Allowed Values: [ "ASSET_MIGRATED", "NOT_SUPPORTED", "ACTION_NEEDED" ]

{
    "type":"object",
    "properties":{
        "artifactId":{
            "type":"string",
            "format":"uuid"
        },
        "artifactName":{
            "type":"string",
            "format":"uuid"
        },
        "artifactType":{
            "type":"string",
            "enum":[
                "PROJECT",
                "FORM",
                "STYLESHEET",
                "DYNAMIC_PROCESS",
                "STRUCTURED_PROCESS",
                "CONNECTOR",
                "ROLE",
                "EXTERNAL_UI",
                "DMN_DIAGRAM",
                "DMN",
                "MAPPING_ACTION",
                "CUSTOM_BUSINESS_OBJECT",
                "BUSINESS_EXCEPTION",
                "LOCALE"
            ]
        },
        "type":{
            "type":"string",
            "enum":[
                "ASSET_MIGRATED",
                "NOT_SUPPORTED",
                "ACTION_NEEDED"
            ]
        },
        "remark":{
            "type":"string"
        }
    }
}

500 Response

An internal error occurred.

Examples

The following example shows how to get a report on a migration by submitting a GET 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: Retrieve details of migration 3fa85f64-5717-4562-b3fc-2c963f66afa6

curl -X 'GET' \
  'https://<OIC URL>/process/api/v1/oic-migration/migrations/3fa85f64-5717-4562-b3fc-2c963f66afa6' \
  -H 'accept: application/json'

Example: Response body of 200 migration report found in JSON format


{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "projectId": null,
  "projectName": "string",
  "projectType": "PROJECT",
  "originalProjectName": "string",
  "migratedBy": "string",
  "migratedOn": "2024-08-09T10:07:48.738Z",
  "result": "string",
  "report": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "remarks": [
      {
        "artifactId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "artifactName": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "artifactType": "PROJECT",
        "type": "ASSET_MIGRATED",
        "remark": "string"
      }
    ]
  }
}