Oracle Database Migration API
Use the table of contents and search tool to explore the Database Migration API.
Oracle Database Migration API is one of 378 APIs that Oracle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Database Migration. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes 69 operations across 56 paths, and defines 104 schemas. It is described by OpenAPI 3.2.0, at version 20230518.
Requests are made against 2 base URLs: http://127.0.0.1/20230518, https://127.0.0.1/20230518.
69 operations
56 paths
104 schemas
5 DELETE32 GET26 POST6 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 69
Across 56 paths, the API surfaces 69 operations — 5 DELETE, 32 GET, 26 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.
databaseMigration 69
Use the table of contents and search tool to explore the Database Migration API.
GET
/assessmentObjectTypes
Display sample object types to exclude or include for an Assessment.
GET
/assessments
List all Assessments.
POST
/assessments
Create an Assessment.
DELETE
/assessments/{assessmentId}
Delete the specified Assessment.
GET
/assessments/{assessmentId}
Display Assessment details
PUT
/assessments/{assessmentId}
Update an Assessment.
POST
/assessments/{assessmentId}/actions/addAssessmentObjects
Add excluded/included object to the list.
POST
/assessments/{assessmentId}/actions/changeCompartment
Change an Assessment compartment.
POST
/assessments/{assessmentId}/actions/clone
Clone an Assessment.
POST
/assessments/{assessmentId}/actions/removeAssessmentObjects
Remove excluded/included objects.
GET
/assessments/{assessmentId}/assessmentObjects
Display excluded/included objects
GET
/assessments/{assessmentId}/assessors
List all Assessors.
GET
/assessments/{assessmentId}/assessors/{assessorName}
Display Assessor details
POST
/assessments/{assessmentId}/assessors/{assessorName}/actions/download_sql
Download SQL script Assessor Action.
POST
/assessments/{assessmentId}/assessors/{assessorName}/assessorActions/{assessorAction}
Assessor Action.
GET
/assessments/{assessmentId}/assessors/{assessorName}/checks
Get Assessor Check Summaries.
GET
/assessments/{assessmentId}/assessors/{assessorName}/checks/{checkName}
Get Assessor Check details.
PUT
/assessments/{assessmentId}/assessors/{assessorName}/checks/{checkName}/actions/updateObjects
Update advisor report object list.
POST
/assessments/{assessmentId}/assessors/{assessorName}/checks/{checkName}/actions/{assessorCheckAction}
Assessor Check Action.
GET
/assessments/{assessmentId}/assessors/{assessorName}/checks/{checkName}/affectedObjects
Display Check Affected objects
GET
/connections
List all Database Connections.
POST
/connections
Create a Database Connection.
GET
/connections/databaseconnectiontype
List supported Database Types, Sub-types and Versions.
DELETE
/connections/{connectionId}
Delete the specified Database Connection.
GET
/connections/{connectionId}
Display Database Connection details
PUT
/connections/{connectionId}
Update a Database Connection.
POST
/connections/{connectionId}/actions/changeCompartment
Change a Database Connection compartment.
POST
/connections/{connectionId}/actions/diagnostics
Perform connection test for a database connection.
GET
/jobs
List all the names of the Migration jobs associated to the specified migration site
DELETE
/jobs/{jobId}
Delete the specified Migration Job
GET
/jobs/{jobId}
pause migration job.
PUT
/jobs/{jobId}
Update Job details.
POST
/jobs/{jobId}/actions/abort
Abort migration operation.
POST
/jobs/{jobId}/actions/collectTraces
Collect DB trace and alert logs.
POST
/jobs/{jobId}/actions/resume
Resume a previously paused migration Job.
POST
/jobs/{jobId}/actions/suspend
Suspend a currently executing migration Job.
GET
/jobs/{jobId}/advisorReport
Get the Pre-Migration Advisor report details
GET
/jobs/{jobId}/advisorReportChecks
List of Pre-Migration checks from the advisor.
PUT
/jobs/{jobId}/advisorReportChecks/{advisorReportCheckId}
Update the premigration extended advisor report check.
POST
/jobs/{jobId}/advisorReportChecks/{advisorReportCheckId}/actions/updateObjects
Update the Pre-Migration extended advisor report object list.
GET
/jobs/{jobId}/advisorReportChecks/{advisorReportCheckId}/objects
Get the Pre-Migration extended Advisor report object list.
GET
/jobs/{jobId}/excludedObjects
List all excluded database objects.
GET
/jobs/{jobId}/output
List the Job Outputs
GET
/jobs/{jobId}/output/content
Get Job Output.
GET
/jobs/{jobId}/parameterFileVersions
Returns a list of parameter file associated with the specified Job.
POST
/jobs/{jobId}/parameterFileVersions
Creates a new version of the current parameter file contents to the specified value.
DELETE
/jobs/{jobId}/parameterFileVersions/{parameterFileName}
Deletes the specified Parameter File Version
GET
/jobs/{jobId}/parameterFileVersions/{parameterFileName}
Provied the content of the provided parameter file.
POST
/jobs/{jobId}/parameterFileVersions/{parameterFileName}/actions/makeCurrent
Make current the given parameter file version
GET
/migrationObjectTypes
Display sample object types to exclude or include for a Migration.
GET
/migrationParameters
List of migration parameters.
GET
/migrations
List all Migrations.
POST
/migrations
Create a Migration.
DELETE
/migrations/{migrationId}
Delete the specified Migration.
GET
/migrations/{migrationId}
Display Migration details
PUT
/migrations/{migrationId}
Update a Migration.
POST
/migrations/{migrationId}/actions/addMigrationObjects
Add excluded/included object to the list.
POST
/migrations/{migrationId}/actions/changeCompartment
Change a Migration compartment.
POST
/migrations/{migrationId}/actions/clone
Clone a Migration.
POST
/migrations/{migrationId}/actions/getSupportedPhases
Display Migration Phases for a specified migration.
POST
/migrations/{migrationId}/actions/removeMigrationObjects
Remove excluded/included objects.
POST
/migrations/{migrationId}/actions/start
Start Migration.
POST
/migrations/{migrationId}/actions/validate
Start Validate Migration.
GET
/migrations/{migrationId}/migrationObjects
Display excluded/included objects
GET
/scripts/{scriptId}
Download DMS script.
GET
/workRequests
Lists work requests in a compartment or for a resource.
GET
/workRequests/{workRequestId}
Gets the details of a work request.
GET
/workRequests/{workRequestId}/errors
Lists work request errors
GET
/workRequests/{workRequestId}/logs
Lists work request logs
Schemas 104
The contract defines 104 schemas that model the data the API accepts and returns. The most detailed are Connection (23 properties), Assessment (20 properties), AssessorCheckSummary (19 properties), Migration (19 properties). Each schema is shown below with its type and property counts.
UpdateAdvisorReportCheckObjectsDetails
object
Optional additional properties for update advisor report check. Default kind is LISTOBJECTS
1 property
1 required
CreateAssessmentDetails
object
Common Create Assessment details.
13 properties
8 required
Migration
object
Migration resource
19 properties
9 required
AdvisorReport
object
Premigration Advisor report details.
6 properties
5 required
WorkRequestSummary
object
A summary of the status of a work request.
8 properties
6 required
PerformAssessorCheckActionDetails
object
Array of name-value pairs for check action.
1 property
1 required
DatabaseTechnologySubType
object
Technology sub-type e.g. ADWSHARED and database versions corresponding to the sub-type.
3 properties
AdvisorReportCheckCollection
object
Pre-Migration extended advisor report result.
2 properties
2 required
AssessmentObjectTypeSummaryCollection
object
Results of an Assessment Object Type listing. Contains AssessmentObjectTypeSummary items.
1 property
1 required
ExcludedObjectSummaryCollection
object
Results of a Job's Exclude objects output listing. Contains ExcludedObjectSummary items.
1 property
1 required
UpdateMigrationDetails
object
Common Update Migration details.
8 properties
1 required
ExcludedObjectSummary
object
Excluded object summary line.
5 properties
4 required
MigrationParameterSummary
Migration parameter response object.
ChangeMigrationCompartmentDetails
object
Details pertaining to change of a migration's compartment.
1 property
1 required
CreateConnectionDetails
object
The information about a new Connection.
14 properties
7 required
JobSummary
object
Job description
12 properties
6 required
WorkRequestCollection
object
Results of a Work Request search. Contains WorkRequestSummary items.
1 property
1 required
DiagnosticsResult
object
Result from Database Connection Diagnostic action.
3 properties
1 required
MigrationObjectCollection
object
Common Migration Objects collection.
1 property
1 required
MigrationObjectTypeSummaryCollection
object
Results of a Migration Object Type listing. Contains MigrationObjectTypeSummary items.
1 property
1 required
ResultError
object
Error Information.
6 properties
2 required
Job
object
Results of a Database Connection search. Contains DatabaseConnectionSummary items.
15 properties
6 required
AssessorCheckAction
object
Assessor Check Action
4 properties
2 required
CollectTracesData
object
Information regarding the DB trace and alert log collection
4 properties
4 required
AdvisorCheckSummary
object
Pre-Migration extended advisor report summary.
5 properties
5 required
LogLocationBucketDetails
object
Details to access log file in the specified Object Storage bucket, if any.
3 properties
3 required
AdvisorReportCheckObjectsCollection
object
Array of check objects.
1 property
1 required
AssessorGroup
object
Assessor Group
4 properties
2 required
AdvisorReportCheckObjectSummary
object
Database objects to migration.
5 properties
2 required
AdvisorReportCheckColumn
object
Head of objects table.
2 properties
2 required
WorkRequestErrorCollection
object
Results of a Work Request search. Contains WorkRequestError items.
1 property
1 required
UserDefinedPropertyOption
object
User defined property option
3 properties
2 required
TargetAssessmentConnection
object
Target Assessment Connection object
5 properties
AssessorCheckSummary
object
Assessor Check Summary
19 properties
4 required
StartMigrationDetails
object
Parameters to specify to a Migration job operation.
1 property
WorkRequestError
object
An error encountered while executing an operation that is tracked by a work request.
3 properties
3 required
AdvisorReportBucketDetails
object
Details to access Premigration Advisor report in the specified Object Storage bucket.
3 properties
3 required
MigrationJobProgressSummary
object
Summary of the progress of a Migration Job.
3 properties
3 required
MigrationParameterBase
object
Migration parameter base object.
2 properties
2 required
ParameterFileVersionCollection
object
The result of the request for Parameter Files. It contains a collection of ParameterFileVersionSummary
1 property
1 required
AssessmentCollection
object
Results of an Assessment search. Contains AssessmentSummary items.
1 property
1 required
AssessmentSummary
object
Assessment Summary resource
11 properties
6 required
ChangeConnectionCompartmentDetails
object
Details for changing the compartment for a Connection.
1 property
1 required
UpdateCheckActionUpdateObjectDetails
object
Details for UpdateCheckActionUpdateObject.
1 property
1 required
SourceAssessmentConnection
object
Source Assessment Connection object
1 property
1 required
ParameterFileVersion
object
Details of a parameter file
7 properties
6 required
WorkRequestLogEntry
object
A log message from executing an operation that is tracked by a work request.
2 properties
2 required
MigrationParameterSummaryCollection
object
List of Migration Parameter Summary objects.
1 property
1 required
DatabaseConnectionTypeCollection
object
Collection of Connection type objects.
1 property
1 required
UpdateAdvisorReportCheckDetails
object
Pre-Migration extended advisor report check item update.
1 property
1 required
JobOutputSummary
object
Job output summary line.
1 property
1 required
AssessorCheckNameValue
object
User Defined Check Name-Value Property
2 properties
2 required
AdvisorReportLocationDetails
object
Details to access Premigration Advisor report.
2 properties
WorkRequest
object
An asynchronous work request.
9 properties
7 required
AssessmentObjectTypeSummary
object
Assessment Object Type
1 property
1 required
AssessorSummary
object
Assessor Summary
14 properties
8 required
MigrationJobProgressResource
object
Progress details of a Migration Job.
3 properties
3 required
UserDefinedProperty
object
User Defined Property
10 properties
3 required
AffectedObjectsCollection
object
Array of check objects.
1 property
1 required
PhaseExtractEntry
object
Job phase extract message.
2 properties
2 required
JobCollection
object
Results of a Job search. Contains JobSummary items.
1 property
1 required
PhaseStatus
object
Job phase status details.
12 properties
3 required
UserDefinedProperties
object
User defined properties
5 properties
1 required
UpdateJobDetails
object
Update Job Details
3 properties
DatabaseTechnologyType
object
Technology type e.g. OCIAUTONOMOUSDATABASE, array of corresponding sub-types e.g. ADWSHARED and versions.
3 properties
1 required
ObjectMetadata
object
Metadata of object.
4 properties
2 required
ResumeJobDetails
object
Parameters to specify to resume a Migration Job.
1 property
Assessor
object
Assessor resource
MigrationPhaseCollection
object
Results of a Migration Phase search. Contains a collection of valid ODMS Job Phases.
1 property
1 required
MigrationCollection
object
Results of a Migration search. Contains MigrationSummary items.
1 property
1 required
CloneAssessmentDetails
object
Customizable details when performing cloning of an Assessment.
7 properties
3 required
AssessorAction
object
Assessor Action
7 properties
4 required
WorkRequestResource
object
A resource that is created or operated on by an asynchronous operation that is tracked by a work request.
4 properties
3 required
UpdateConnectionDetails
object
The information to update a Connection.
13 properties
OdmsPhaseActions
string
Possible ODMS Job Phase actions.
CreateParameterFileVersionDetails
object
Details about a specific ParameterFileVersion
4 properties
2 required
IngressIpDetails
object
Private Endpoint IP Addresses created in the customer's subnet.
1 property
1 required
ConnectionCollection
object
Array of connection summary objects.
1 property
1 required
DownloadSqlDetails
object
The response object of the Download SQL action
1 property
1 required
MigrationPhaseSummary
object
Migration Phase Summary of details.
3 properties
2 required
MigrationObjectTypeSummary
object
Migration Object Type
1 property
1 required
AssessorSummaryCollection
object
Collection of assessor summaries.
1 property
1 required
AssessorCheckSummaryCollection
object
Collection of assessor check summaries.
1 property
1 required
DatabaseConnectionTypeSummary
object
Connection type e.g. ORACLE and array of technology type objects.
2 properties
1 required
AdvisorReportCheckSummary
object
Pre-Migration extended advisor report check item.
12 properties
10 required
WorkRequestLogEntryCollection
object
Results of a Work Request search. Contains WorkRequestLogEntry items.
1 property
1 required
Connection
object
Represents the common details required for creating a new connection.
23 properties
8 required
DatabaseInformation
object
Database Information.
3 properties
JobOutputSummaryCollection
object
Results of a Job output listing. Contains JobOutputSummary items.
1 property
1 required
AssessmentObjectCollection
object
Assessment Objects collection.
1 property
1 required
ConnectionSummary
object
Represents the parameters common for all connections in list operation.
17 properties
7 required
PerformAssessorActionDetails
object
Array of name-value pairs for assessor action.
1 property
1 required
UnsupportedDatabaseObject
object
Database objects to exclude from migration
3 properties
2 required
Error
object
Error Information.
2 properties
2 required
AssessorCheck
object
Assessor Check
CloneMigrationDetails
object
Customizable details when performing cloning of a migration.
8 properties
3 required
ParameterFileVersionSummary
object
Details of a parameter file
9 properties
5 required
CreateMigrationDetails
object
Common Migration details.
10 properties
3 required
UpdateAssessmentDetails
object
Common Update Assessment details.
12 properties
1 required
CollectTracesDetails
object
Details for collecting DB traces and alert logs
3 properties
3 required
AssessorCheckGroup
object
Assessor Check Group
4 properties
2 required
ChangeAssessmentCompartmentDetails
object
Details pertaining to change of an assessment's compartment.
1 property
1 required
Assessment
object
Assessment resource
20 properties
13 required
MigrationSummary
object
Migration resource
17 properties
9 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Oracle 12
Other APIs Oracle publishes across the network.
Oracle Database REST APIs
Oracle Integration Cloud API
Oracle Fusion Cloud Applications API
Oracle Fusion Cloud Financials REST API
Oracle Fusion Cloud HCM REST API
Oracle Fusion Cloud CX Sales and Service REST API
Oracle Fusion Cloud SCM REST API
Oracle Fusion Cloud Procurement REST API
Oracle Content Management API
OCI Generative AI API
OCI AI Vision API
OCI AI Language API
#Database Migration
Where this information came from
This is an independent, third-party profile of Oracle Database Migration API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.