openapi: 3.2.0 info: description: Use the Oracle Cloud Infrastructure Database Migration APIs to perform database migration operations. title: Database Migration API version: '20230518' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/6d28f54c506b93656daaec68b30b1a1d6fe140dae6c525cdb129564e45923499.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Database Migration API OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/6d28f54c506b93656daaec68b30b1a1d6fe140dae6c525cdb129564e45923499.yaml what: the harvested document for Database Migration API servers: - url: http://127.0.0.1/20230518 - url: https://127.0.0.1/20230518 tags: - description: Use the table of contents and search tool to explore the Database Migration API. name: databaseMigration paths: /assessmentObjectTypes: get: description: 'Display sample object types to exclude or include for an Assessment. ' operationId: ListAssessmentObjectTypes parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/SortByObjectTypeParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/AssessmentObjectsConnectionTypeQueryParam' responses: '200': description: 'A list of Object Types. ' headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AssessmentObjectTypeSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Display sample object types to exclude or include for an Assessment. tags: - databaseMigration x-related-resource: '#/definitions/AssessmentObjectTypeSummary' /assessments: get: description: 'List all Assessments. ' operationId: ListAssessments parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/AssessmentLifecycleStateQueryParam' - $ref: '#/components/parameters/LifecycleDetailsQueryParam' responses: 200: description: 'A page of AssessmentSummary objects. ' headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AssessmentCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List all Assessments. tags: - databaseMigration x-related-resource: '#/definitions/AssessmentSummary' post: description: 'Create an Assessment resource that contains all the details to perform the database assessment operation, such as source and destination database details, network throughput, accepted downtime etc. ' operationId: CreateAssessment parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: '201': description: 'Created. A JSON object containing an Assessment resource representation. ' headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Assessment' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Create an Assessment. tags: - databaseMigration x-related-resource: '#/definitions/Assessment' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAssessmentDetails' description: Assessment properties. required: true /assessments/{assessmentId}: delete: description: 'Deletes the Assessment represented by the specified assessment ID. ' operationId: DeleteAssessment parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/AssessmentIdPathParam' responses: '202': description: 'Accepted. ' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete the specified Assessment. tags: - databaseMigration x-related-resource: '#/definitions/Assessment' get: description: 'Display Assessment details. ' operationId: GetAssessment parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/AssessmentIdPathParam' responses: '200': description: 'OK. A JSON object containing an Assessment resource representation. ' headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Assessment' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Display Assessment details tags: - databaseMigration put: description: 'Update Assessment resource details. ' operationId: UpdateAssessment parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/AssessmentIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: '202': description: 'Accepted. ' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update an Assessment. tags: - databaseMigration x-related-resource: '#/definitions/Assessment' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAssessmentDetails' description: 'Assessment properties. ' required: true /assessments/{assessmentId}/actions/addAssessmentObjects: post: description: 'Add excluded/included object to the list. ' operationId: AddAssessmentObjects parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/AssessmentIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: 'Accepted. ' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Add excluded/included object to the list. tags: - databaseMigration x-related-resource: '#/definitions/Assessment' requestBody: content: application/json: schema: $ref: '#/components/schemas/AssessmentObjectCollection' description: 'Arrays of object. ' required: true /assessments/{assessmentId}/actions/changeCompartment: post: description: 'Used to change the Assessment compartment. ' operationId: ChangeAssessmentCompartment parameters: - $ref: '#/components/parameters/AssessmentIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: 'Accepted. ' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Change an Assessment compartment. tags: - databaseMigration x-related-resource: '#/definitions/Assessment' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeAssessmentCompartmentDetails' description: 'Details to change the compartment. ' required: true /assessments/{assessmentId}/actions/clone: post: description: 'Clone a configuration from an existing Assessment. ' operationId: CloneAssessment parameters: - $ref: '#/components/parameters/AssessmentIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: 'Accepted. A JSON object containing an Assessment resource representation. ' headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Assessment' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Clone an Assessment. tags: - databaseMigration x-related-resource: '#/definitions/Assessment' requestBody: content: application/json: schema: $ref: '#/components/schemas/CloneAssessmentDetails' description: 'Clone Assessment properties. ' required: true /assessments/{assessmentId}/actions/removeAssessmentObjects: post: description: 'Remove excluded/included objects. ' operationId: RemoveAssessmentObjects parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/AssessmentIdPathParam' responses: 202: description: 'Accepted. ' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Remove excluded/included objects. tags: - databaseMigration x-related-resource: '#/definitions/Assessment' requestBody: content: application/json: schema: $ref: '#/components/schemas/AssessmentObjectCollection' description: 'Arrays of object. ' required: true /assessments/{assessmentId}/assessmentObjects: get: description: 'Display excluded/included objects. ' operationId: ListAssessmentObjects parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/AssessmentIdPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: 'OK. A JSON object containing a array of excluded/included objects. ' headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AssessmentObjectCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Display excluded/included objects tags: - databaseMigration /assessments/{assessmentId}/assessors: get: description: 'List all Assessors. ' operationId: ListAssessors parameters: - $ref: '#/components/parameters/AssessmentIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/AssessorLifecycleStateQueryParam' responses: 200: description: 'A page of AssessorSummary objects. ' headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AssessorSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List all Assessors. tags: - databaseMigration x-related-resource: '#/definitions/AssessorSummary' /assessments/{assessmentId}/assessors/{assessorName}: get: description: Display Assessor details. operationId: GetAssessor parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/AssessmentIdPathParam' - $ref: '#/components/parameters/AssessorNamePathParam' responses: '200': description: 'OK. A JSON object containing an Assessor resource representation. ' headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Assessor' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Display Assessor details tags: - databaseMigration /assessments/{assessmentId}/assessors/{assessorName}/actions/download_sql: post: description: Download SQL script Assessor Action. operationId: PerformAssessorActionDownloadSql parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/AssessmentIdPathParam' - $ref: '#/components/parameters/AssessorNamePathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: 'Accepted. ' headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DownloadSqlDetails' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Download SQL script Assessor Action. tags: - databaseMigration x-related-resource: '#/definitions/Assessment' /assessments/{assessmentId}/assessors/{assessorName}/assessorActions/{assessorAction}: post: description: Assessor Action. operationId: PerformAssessorAction parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/AssessmentIdPathParam' - $ref: '#/components/parameters/AssessorNamePathParam' - $ref: '#/components/parameters/AssessorActionPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: 'Accepted. ' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Assessor Action. tags: - databaseMigration x-related-resource: '#/definitions/Assessment' requestBody: content: application/json: schema: $ref: '#/components/schemas/PerformAssessorActionDetails' description: Assessor action details. /assessments/{assessmentId}/assessors/{assessorName}/checks: get: description: 'List Assessor Check Summaries. ' operationId: ListAssessorChecks parameters: - $ref: '#/components/parameters/AssessmentIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/AssessorNamePathParam' responses: 200: description: 'A page of AssessorCheckGroupSummary objects. ' headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AssessorCheckSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get Assessor Check Summaries. tags: - databaseMigration x-related-resource: '#/definitions/AssessorCheckSummary' /assessments/{assessmentId}/assessors/{assessorName}/checks/{checkName}: get: description: 'Get Assessor Check details. ' operationId: GetAssessorCheck parameters: - $ref: '#/components/parameters/AssessmentIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/AssessorNamePathParam' - $ref: '#/components/parameters/AssessorCheckNamePathParam' responses: 200: description: 'A details of Assessor Check objects. ' headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AssessorCheck' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get Assessor Check details. tags: - databaseMigration x-related-resource: '#/definitions/AssessorCheck' /assessments/{assessmentId}/assessors/{assessorName}/checks/{checkName}/actions/updateObjects: put: description: 'Update the advisor report object list. ' operationId: UpdateCheckActionUpdateObject parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/SortByObjectTypeParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/AssessmentIdPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/AssessorNamePathParam' - $ref: '#/components/parameters/AssessorCheckNamePathParam' responses: '200': description: 'OK. The affected objects updated. ' headers: opc-request-id: description: Unique Oracle-assigned identifier for the request. schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update advisor report object list. tags: - databaseMigration x-related-resource: '#/definitions/AdvisorReportCheckCollection' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateCheckActionUpdateObjectDetails' description: 'Collection of AdvisorReportCheckObjectSummary. ' required: true /assessments/{assessmentId}/assessors/{assessorName}/checks/{checkName}/actions/{assessorCheckAction}: post: description: Assessor Check Action. operationId: PerformAssessorCheckAction parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/AssessmentIdPathParam' - $ref: '#/components/parameters/AssessorNamePathParam' - $ref: '#/components/parameters/AssessorCheckNamePathParam' - $ref: '#/components/parameters/AssessorCheckActionPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: 'Accepted. ' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Assessor Check Action. tags: - databaseMigration x-related-resource: '#/definitions/Assessment' requestBody: content: application/json: schema: $ref: '#/components/schemas/PerformAssessorCheckActionDetails' description: Check action details. required: true /assessments/{assessmentId}/assessors/{assessorName}/checks/{checkName}/affectedObjects: get: description: 'Display Check Affected objects. ' operationId: ListAffectedObjects parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/SortByObjectTypeParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/AssessmentIdPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/AssessorNamePathParam' - $ref: '#/components/parameters/AssessorCheckNamePathParam' responses: 200: description: 'OK. A collection containing affected database objects. ' headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AffectedObjectsCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Display Check Affected objects tags: - databaseMigration x-related-resource: '#/definitions/AssessorCheck' /connections: get: description: 'List all Database Connections. ' operationId: ListConnections parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/TechnologyTypeQueryParam' - $ref: '#/components/parameters/TechnologySubTypeQueryParam' - $ref: '#/components/parameters/ConnectionTypeQueryParam' - $ref: '#/components/parameters/SourceConnectionIdPathParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' responses: '200': description: 'A page of ConnectionSummary objects. ' headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ConnectionCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List all Database Connections. tags: - databaseMigration x-related-resource: '#/definitions/ConnectionSummary' post: description: 'Create a Database Connection resource that contains the details to connect to either a Source or Target Database in the migration. ' operationId: CreateConnection parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: '201': description: 'Accepted. A JSON object containing a Database Connection resource representation. ' headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Connection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Create a Database Connection. tags: - databaseMigration requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateConnectionDetails' description: 'Database Connection properties. ' required: true /connections/databaseconnectiontype: get: description: List supported Database Types, Sub-types and Versions. operationId: ListDatabaseConnectionType parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/TechnologyTypeQueryParam' - $ref: '#/components/parameters/ConnectionTypeQueryParam' - $ref: '#/components/parameters/SourceConnectionIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: '200': description: Collection of supported types. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DatabaseConnectionTypeCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List supported Database Types, Sub-types and Versions. tags: - databaseMigration x-related-resource: '#/definitions/DatabaseConnectionTypeSummary' /connections/{connectionId}: delete: description: 'Deletes the Database Connection represented by the specified connection ID. ' operationId: DeleteConnection parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/ConnectionIdPathParam' responses: '202': description: 'Accepted. ' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete the specified Database Connection. tags: - databaseMigration x-related-resource: '#/definitions/Connection' get: description: 'Display Database Connection details. ' operationId: GetConnection parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/ConnectionIdPathParam' responses: '200': description: 'OK. A JSON object containing a Database Connection resource representation. ' headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Connection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Display Database Connection details tags: - databaseMigration put: description: 'Update Database Connection resource details. ' operationId: UpdateConnection parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/ConnectionIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: '202': description: 'Accepted. ' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update a Database Connection. tags: - databaseMigration x-related-resource: '#/definitions/Connection' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateConnectionDetails' description: 'Database Connection properties. ' required: true /connections/{connectionId}/actions/changeCompartment: post: description: 'Used to change the Database Connection compartment. ' operationId: ChangeConnectionCompartment parameters: - $ref: '#/components/parameters/ConnectionIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: 'Accepted. ' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Change a Database Connection compartment. tags: - databaseMigration x-related-resource: '#/definitions/Connection' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeConnectionCompartmentDetails' description: 'Details to change the compartment. ' required: true /connections/{connectionId}/actions/diagnostics: post: description: 'Perform connection test for a database connection. ' operationId: ConnectionDiagnostics parameters: - $ref: '#/components/parameters/ConnectionIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - description: When true, run assessment validation checks (e.g., DMSROLE) and include database information (name/version/size) in the response. in: query name: isAssessmentValidation required: false schema: type: boolean default: false responses: 200: description: 'Action performed. ' headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DiagnosticsResult' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Perform connection test for a database connection. tags: - databaseMigration x-obmcs-terraform: actionType: START x-related-resource: '#/definitions/Connection' /jobs: get: description: 'List all the names of the Migration jobs associated to the specified migration site. ' operationId: ListJobs parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/MigrationIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/JobLifecycleOperationQueryParam' - $ref: '#/components/parameters/JobIdNotEqualToQueryParam' responses: '200': description: 'A page of JobSummary objects. ' headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/JobCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'List all the names of the Migration jobs associated to the specified migration site ' tags: - databaseMigration x-related-resource: '#/definitions/JobSummary' /jobs/{jobId}: delete: description: 'Deletes the migration job represented by the given job ID. ' operationId: DeleteJob parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/JobIdPathParam' responses: '204': description: 'OK. ' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete the specified Migration Job tags: - databaseMigration x-related-resource: '#/definitions/Job' get: description: 'Get a migration job. ' operationId: GetJob parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/JobIdPathParam' responses: 200: description: 'OK. A JSON object containing a job resource representation with multiple properties and the links array with at least the "self" link. ' headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Job' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: pause migration job. tags: - databaseMigration put: description: 'Update Migration Job resource details. ' operationId: UpdateJob parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/JobIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: '200': description: 'Ok. A Job resource representation. ' headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Job' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update Job details. tags: - databaseMigration requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateJobDetails' description: 'Migration Job properties. ' required: true /jobs/{jobId}/actions/abort: post: description: 'Aborts a Migration Job (either Evaluation or Migration). ' operationId: AbortJob parameters: - $ref: '#/components/parameters/JobIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: 'OK. A JSON object containing a job resource representation with multiple properties and the links array with at least the "self" link. ' headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Job' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Abort migration operation. tags: - databaseMigration x-related-resource: '#/definitions/Job' /jobs/{jobId}/actions/collectTraces: post: description: 'Collects the DB trace and alert logs. ' operationId: CollectTraces parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/JobIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: 'Collect traces request accepted. ' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Job' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Collect DB trace and alert logs. tags: - databaseMigration x-related-resource: '#/definitions/Job' requestBody: content: application/json: schema: $ref: '#/components/schemas/CollectTracesDetails' description: 'Information on where the traces will be stored. ' required: true /jobs/{jobId}/actions/resume: post: description: 'Resume a migration Job. ' operationId: ResumeJob parameters: - $ref: '#/components/parameters/JobIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: 'OK. A JSON object containing a job resource representation with multiple properties and the links array with at least the "self" link. ' headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Job' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Resume a previously paused migration Job. tags: - databaseMigration x-related-resource: '#/definitions/Job' requestBody: content: application/json: schema: $ref: '#/components/schemas/ResumeJobDetails' description: 'Resume Job options. ' /jobs/{jobId}/actions/suspend: post: description: 'Place the currently executing migration Job in a Suspended State. ' operationId: SuspendJob parameters: - $ref: '#/components/parameters/JobIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: 'Suspend Job Request accepted ' headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Job' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Suspend a currently executing migration Job. tags: - databaseMigration x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/Job' /jobs/{jobId}/advisorReport: get: description: 'Get the Pre-Migration Advisor report details ' operationId: GetAdvisorReport parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/JobIdPathParam' responses: 200: description: 'OK. Return an Advisor Report object. ' headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AdvisorReport' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get the Pre-Migration Advisor report details tags: - databaseMigration x-related-resource: '#/definitions/Job' /jobs/{jobId}/advisorReportChecks: get: description: 'List of Pre-Migration checks from the advisor. ' operationId: ListAdvisorReportChecks parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/JobIdPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: 'OK. Return an Extended Advisor Report object. ' headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AdvisorReportCheckCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List of Pre-Migration checks from the advisor. tags: - databaseMigration x-related-resource: '#/definitions/Job' /jobs/{jobId}/advisorReportChecks/{advisorReportCheckId}: put: description: 'Update the premigration extended Advisor report check. ' operationId: UpdateAdvisorReportCheck parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/JobIdPathParam' - $ref: '#/components/parameters/AdvisorReportCheckIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: '200': description: 'OK. ' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the premigration extended advisor report check. tags: - databaseMigration requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAdvisorReportCheckDetails' description: 'Update advisor report check. ' required: true /jobs/{jobId}/advisorReportChecks/{advisorReportCheckId}/actions/updateObjects: post: description: 'Update the Pre-Migration extended Advisor report object list. ' operationId: UpdateAdvisorReportCheckObjects parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/JobIdPathParam' - $ref: '#/components/parameters/AdvisorReportCheckIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: '200': description: 'OK. The status of the list of objects has been changed. ' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the Pre-Migration extended advisor report object list. tags: - databaseMigration x-related-resource: '#/definitions/AdvisorReportCheckCollection' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAdvisorReportCheckObjectsDetails' description: 'Collection of AdvisorReportCheckObjectSummary. ' required: true /jobs/{jobId}/advisorReportChecks/{advisorReportCheckId}/objects: get: description: 'Get the Pre-Migration extended Advisor report object list. ' operationId: ListAdvisorReportCheckObjects parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/JobIdPathParam' - $ref: '#/components/parameters/AdvisorReportCheckIdPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: 'OK. Return an Extended Advisor Report object list. ' headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AdvisorReportCheckObjectsCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get the Pre-Migration extended Advisor report object list. tags: - databaseMigration x-related-resource: '#/definitions/Job' /jobs/{jobId}/excludedObjects: get: description: 'List the excluded database objects. ' operationId: ListExcludedObjects parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/JobIdPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ObjectReportSortByQueryParam' - $ref: '#/components/parameters/ObjectTypeQueryParam' - $ref: '#/components/parameters/ObjectOwnerQueryParam' - $ref: '#/components/parameters/ObjectNameQueryParam' - $ref: '#/components/parameters/ObjectOwnerContainsQueryParam' - $ref: '#/components/parameters/ObjectNameContainsQueryParam' - $ref: '#/components/parameters/ExcludeReasonCategoryQueryParam' - $ref: '#/components/parameters/ExcludeRuleQueryParam' responses: 200: description: 'A page of ExcludedObjectSummary objects. ' headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ExcludedObjectSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List all excluded database objects. tags: - databaseMigration x-related-resource: '#/definitions/ExcludedObjectSummary' /jobs/{jobId}/output: get: description: 'List the Job Outputs ' operationId: ListJobOutputs parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/JobIdPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: 'A page of JobOutputSummary objects. ' headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/JobOutputSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List the Job Outputs tags: - databaseMigration x-related-resource: '#/definitions/JobOutputSummary' /jobs/{jobId}/output/content: get: description: 'Get the migration Job Output content as a String. ' operationId: GetJobOutputContent parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/JobIdPathParam' responses: 200: description: 'OK. The response body will contain the specified job output content as a binary file (string). ' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/x-yaml: schema: format: binary type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get Job Output. tags: - databaseMigration x-related-resource: '#/definitions/Job' /jobs/{jobId}/parameterFileVersions: get: description: 'Return a list of the parameter file metadata of the migration execution of the specified job. This will only be acceptable if the job is in particular state. It will be accessible if the job is in the FAILED, PAUSED or SUSPENDED state. ' operationId: ListParameterFileVersions parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/JobIdPathParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: '200': description: 'A page of ParameterFileVersionSummary objects. ' headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ParameterFileVersionCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Returns a list of parameter file associated with the specified Job. ' tags: - databaseMigration x-related-resource: '#/definitions/Job' post: description: 'Creates a new version of the current parameter file contents to the specified value. ' operationId: CreateParameterFileVersion parameters: - $ref: '#/components/parameters/JobIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: 'Request for set the Parameter File Version was successful. ' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new version of the current parameter file contents to the specified value. tags: - databaseMigration x-related-resource: '#/definitions/Job' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateParameterFileVersionDetails' description: 'The parameter file version details to be created ' required: true /jobs/{jobId}/parameterFileVersions/{parameterFileName}: delete: description: 'Deletes the given parameter file version ' operationId: DeleteParameterFileVersion parameters: - $ref: '#/components/parameters/JobIdPathParam' - $ref: '#/components/parameters/ParameterFileNamePathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: 'Accepted. ' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes the specified Parameter File Version tags: - databaseMigration x-related-resource: '#/definitions/Job' get: description: 'Obtain the parameter file version contents for the specified parameter file name and the associated job. This operation will be allowed only if the job is certain acceptable lifecycle states. ' operationId: GetParameterFileVersion parameters: - $ref: '#/components/parameters/ParameterFileNamePathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/JobIdPathParam' responses: 200: description: Request to get the contents of the parameter file was successful. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ParameterFileVersion' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Provied the content of the provided parameter file. tags: - databaseMigration x-related-resource: '#/definitions/Job' /jobs/{jobId}/parameterFileVersions/{parameterFileName}/actions/makeCurrent: post: description: 'Make current the given parameter file version ' operationId: MakeCurrentParameterFileVersion parameters: - $ref: '#/components/parameters/JobIdPathParam' - $ref: '#/components/parameters/ParameterFileNamePathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: 'Make current request was accepted ' headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Job' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Make current the given parameter file version tags: - databaseMigration x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/Job' /migrationObjectTypes: get: description: 'Display sample object types to exclude or include for a Migration. ' operationId: ListMigrationObjectTypes parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/SortByObjectTypeParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/MigrationObjectsConnectionTypeQueryParam' responses: '200': description: 'A list of Object Types. ' headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MigrationObjectTypeSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Display sample object types to exclude or include for a Migration. tags: - databaseMigration x-related-resource: '#/definitions/MigrationObjectTypeSummary' /migrationParameters: get: description: List of parameters that can be used to customize migrations. operationId: ListMigrationParameters parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/MigrationTypeQueryParam' - $ref: '#/components/parameters/DatabaseCombinationQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: '200': description: List of Migration Parameters. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MigrationParameterSummaryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List of migration parameters. tags: - databaseMigration x-related-resource: '#/definitions/MigrationParameterSummary' /migrations: get: description: 'List all Migrations. ' operationId: ListMigrations parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/MigrationLifecycleStateQueryParam' - $ref: '#/components/parameters/LifecycleDetailsQueryParam' responses: 200: description: 'A page of MigrationSummary objects. ' headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MigrationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List all Migrations. tags: - databaseMigration x-related-resource: '#/definitions/MigrationSummary' post: description: 'Create a Migration resource that contains all the details to perform the database migration operation, such as source and destination database details, credentials, etc. ' operationId: CreateMigration parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: '201': description: 'Created. A JSON object containing a Migration resource representation. ' headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Migration' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Create a Migration. tags: - databaseMigration x-related-resource: '#/definitions/Migration' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateMigrationDetails' description: Migration properties. required: true /migrations/{migrationId}: delete: description: 'Deletes the Migration represented by the specified migration ID. ' operationId: DeleteMigration parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/MigrationIdPathParam' responses: '202': description: 'Accepted. ' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete the specified Migration. tags: - databaseMigration x-related-resource: '#/definitions/Migration' get: description: 'Display Migration details. ' operationId: GetMigration parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/MigrationIdPathParam' responses: '200': description: 'OK. A JSON object containing a migration resource representation. ' headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Migration' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Display Migration details tags: - databaseMigration put: description: 'Update Migration resource details. ' operationId: UpdateMigration parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/MigrationIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: '202': description: 'Accepted. ' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update a Migration. tags: - databaseMigration x-related-resource: '#/definitions/Migration' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateMigrationDetails' description: 'Migration properties. ' required: true /migrations/{migrationId}/actions/addMigrationObjects: post: description: 'Add excluded/included object to the list. ' operationId: AddMigrationObjects parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/MigrationIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: 'Accepted. ' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Add excluded/included object to the list. tags: - databaseMigration x-related-resource: '#/definitions/Migration' requestBody: content: application/json: schema: $ref: '#/components/schemas/MigrationObjectCollection' description: 'Arrays of object. ' required: true /migrations/{migrationId}/actions/changeCompartment: post: description: 'Used to change the Migration compartment. ' operationId: ChangeMigrationCompartment parameters: - $ref: '#/components/parameters/MigrationIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: 'Accepted. ' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Change a Migration compartment. tags: - databaseMigration x-related-resource: '#/definitions/Migration' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeMigrationCompartmentDetails' description: 'Details to change the compartment. ' required: true /migrations/{migrationId}/actions/clone: post: description: 'Clone a configuration from an existing Migration. ' operationId: CloneMigration parameters: - $ref: '#/components/parameters/MigrationIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: 'Accepted. A JSON object containing a Migration resource representation. ' headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Migration' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Clone a Migration. tags: - databaseMigration x-related-resource: '#/definitions/Migration' requestBody: content: application/json: schema: $ref: '#/components/schemas/CloneMigrationDetails' description: 'Clone Migration properties. ' required: true /migrations/{migrationId}/actions/getSupportedPhases: post: description: 'Display Migration Phases for a specified migration. ' operationId: RetrieveSupportedPhases parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/MigrationIdPathParam' responses: '200': description: 'A list of Migration Phase objects. ' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MigrationPhaseCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Display Migration Phases for a specified migration. tags: - databaseMigration x-related-resource: '#/definitions/Migration' /migrations/{migrationId}/actions/removeMigrationObjects: post: description: 'Remove excluded/included objects. ' operationId: RemoveMigrationObjects parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/MigrationIdPathParam' responses: 202: description: 'Accepted. ' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Remove excluded/included objects. tags: - databaseMigration x-related-resource: '#/definitions/Migration' requestBody: content: application/json: schema: $ref: '#/components/schemas/MigrationObjectCollection' description: 'Arrays of object. ' required: true /migrations/{migrationId}/actions/start: post: description: 'Start Migration job. ' operationId: StartMigration parameters: - $ref: '#/components/parameters/MigrationIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: 'Accepted. A JSON object containing a job resource representation. ' headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Job' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Start Migration. tags: - databaseMigration x-related-resource: '#/definitions/Job' requestBody: content: application/json: schema: $ref: '#/components/schemas/StartMigrationDetails' description: 'Start Migration Job properties. ' /migrations/{migrationId}/actions/validate: post: description: 'Start Validate Migration job. ' operationId: EvaluateMigration parameters: - $ref: '#/components/parameters/MigrationIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: 'Accepted. A JSON object containing a job resource representation. ' headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Job' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Start Validate Migration. tags: - databaseMigration x-related-resource: '#/definitions/Job' /migrations/{migrationId}/migrationObjects: get: description: 'Display excluded/included objects. ' operationId: ListMigrationObjects parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/MigrationIdPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: 'OK. A JSON object containing a array of excluded/included objects. ' headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MigrationObjectCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Display excluded/included objects tags: - databaseMigration /scripts/{scriptId}: get: description: Download DMS script. operationId: GetScript parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/ScripIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The script content in response. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: format: binary type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Download DMS script. tags: - databaseMigration /workRequests: get: description: 'Lists the work requests in a compartment or for a specified resource. ' operationId: ListWorkRequests parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ResourceIdQueryParam' - $ref: '#/components/parameters/WorkRequestStatusQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/WorkRequestSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: 'The list of work requests. ' headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Lists work requests in a compartment or for a resource. tags: - databaseMigration x-related-resource: '#/definitions/WorkRequestSummary' /workRequests/{workRequestId}: get: description: 'Gets the details of a work request. ' operationId: GetWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: 'The details of the work request. ' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequest' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the details of a work request. tags: - databaseMigration /workRequests/{workRequestId}/errors: get: description: 'Gets the errors for a work request. ' operationId: ListWorkRequestErrors parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/WorkRequestLogSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: 'The list of work request errors. ' headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestErrorCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Lists work request errors tags: - databaseMigration x-related-resource: '#/definitions/WorkRequestError' /workRequests/{workRequestId}/logs: get: description: 'Gets the logs for a work request. ' operationId: ListWorkRequestLogs parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/WorkRequestLogSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: 'The list of work request logs. ' headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestLogEntryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Lists work request logs tags: - databaseMigration x-related-resource: '#/definitions/WorkRequestLogEntry' components: schemas: ResultError: description: 'Error Information. ' properties: action: description: 'The text describing the action required to fix the issue ' type: string actionLink: description: 'The link to the documentation ' type: string actionText: description: 'The text for the link to the documentation ' type: string code: description: 'A short error code that defines the error, meant for programmatic parsing. ' type: string issue: description: 'The text describing the root cause of the reported issue ' type: string message: description: 'A human-readable error string. ' type: string required: - code - message x-example: "{\n \"code\": \"DMS-0003\",\n \"message\": \"The database server is not reachable\",\n \"issue\": \"The connection to the database server was not established. \",\n \"action\": \"Verify the provided ip/host and port are correct and complete, also verify the port is open for connections.\"\n}\n" AssessorGroup: description: Assessor Group properties: actions: description: Assessor group actions. items: $ref: '#/components/schemas/AssessorAction' maxLength: 1 minLength: 0 type: array description: description: "A user-friendly description. Does not have to be unique, and it's changeable. \nAvoid entering confidential information.\n" maxLength: 400 minLength: 0 type: string x-default-description: 'null' displayName: description: "A user-friendly name. Does not have to be unique, and it's changeable. \nAvoid entering confidential information.\n" maxLength: 255 minLength: 1 type: string name: description: Assessor Group name, e.g. ADVANCED. maxLength: 255 minLength: 0 type: string required: - name - displayName type: object PerformAssessorCheckActionDetails: description: Array of name-value pairs for check action. properties: items: description: Array of user defined details for check action. items: $ref: '#/components/schemas/AssessorCheckNameValue' type: array required: - items type: object MigrationCollection: description: Results of a Migration search. Contains MigrationSummary items. properties: items: description: Items in collection. items: $ref: '#/components/schemas/MigrationSummary' type: array required: - items type: object x-example: "Example of MigrationCollection response with one migration:\n{\n \"items\": [\n {\n \"id\": \"ocid1.odms-migration.oc1..exampleunique_ID\",\n \"compartmentId\": \"ocid1.compartment.oc1..exampleunique_ID\",\n \"displayName\": \"migrationName\",\n \"type\": \"ONLINE\",\n \"timeCreated\": \"2020-08-03T16:46:26.550Z\",\n \"timeUpdated\": \"2020-08-03T16:46:26.550Z\",\n \"lifecycleState\": \"ACTIVE\",\n \"lifecycleDetails\": \"READY\"\n }\n ]\n}\n" Error: description: 'Error Information. ' properties: code: description: 'A short error code that defines the error, meant for programmatic parsing. ' type: string message: description: 'A human-readable error string. ' type: string required: - code - message x-example: "{\n \"code\": \"BadRequest\",\n \"message\": \"Invalid format.\"\n}\n" AdvisorReportCheckCollection: description: 'Pre-Migration extended advisor report result. ' properties: items: description: 'Array of advisor check items. ' items: $ref: '#/components/schemas/AdvisorReportCheckSummary' type: array summary: $ref: '#/components/schemas/AdvisorCheckSummary' required: - summary - items type: object x-example: "{\n \"summary\": {\n \"passResultsTotalCount\": ###,\n \"informationalResultsTotalCount\": ###,\n \"warningResultsTotalCount\": ###,\n \"blockerResultsTotalCount\": ###,\n \"fatalResultsTotalCount\": ###\n },\n \"items\": [\n {\n \"key\": \"has_columns_of_rowid_type\"\n \"displayName\": \"Has columns of rowid type\"\n \"resultType\": \"enum value of result\" (i.e. BLOCKER, FATAL, WARNING, etc...),\n \"issue\": \"The ROWID data type is not enabled by default in Dedicated Infrastructure\",\n \"impact\": \"By default, columns with ROWID data type cannot be migrated to ATPD or ADWD.\",\n \"action\": \"Columns with Media data types are not allowed in Autonomous Database\",\n \"metadata\": {\n \"schemaOwnerColumn\": \"OWNER\",\n \"objectNameColumn\": \"TABLE_NAME\",\n \"objectTypeFixed\": \"TABLE\",\n \"objectTypeColumn\": \"\",\n },\n \"fixupScriptLocation\": \"/path/\",\n \"isExclusionAllowed\": true/false,\n \"columns\": [\n {\n \"id\": \"TABLE_NAME\",\n \"displayName\": \"Table\",\n }\n ],\n \"objectCount\": ###\n }\n ]\n}\n" ParameterFileVersionSummary: description: Details of a parameter file properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: A description to discribe the current parameter file version type: string freeformTags: additionalProperties: type: string description: "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. \nFor more information, see Resource Tags. Example: {\"Department\": \"Finance\"}\n" type: object isCurrent: description: Return boolean true/false for the currently in-use parameter file (factory or a versioned file) type: boolean isFactory: description: Return true/false for whether the parameter file is oracle provided (Factory) type: boolean kind: description: Indicator of Parameter File 'kind' (for an EXTRACT or a REPLICAT) enum: - EXTRACT - REPLICAT type: string x-obmcs-top-level-enum: '#/definitions/JobParameterFileVersionKind' name: description: A unique name associated with the current migration/job and extract/replicat name type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The time when this parameter file was applied on the process ' format: date-time type: string required: - name - kind - isCurrent - isFactory - timeCreated type: object x-example: "{\n \"name\": \"EXTNOWL9_ORIGINAL\",\n \"kind\": \"EXTRACT\",\n \"timeCreated\": \"2019-05-07T00:00:03.374Z\"\n}\n" JobOutputSummary: description: 'Job output summary line. ' properties: message: description: 'Job output line. ' type: string required: - message type: object x-message: "{\n \"message\": \"nodeName.domain.com: Audit ID: 6\"\n}\n" Connection: description: Represents the common details required for creating a new connection. discriminator: propertyName: connectionType properties: compartmentId: description: The OCID of the compartment. maxLength: 255 minLength: 1 type: string connectionType: description: Defines the type of connection. For example, ORACLE. enum: - MYSQL - ORACLE type: string x-obmcs-top-level-enum: '#/definitions/ConnectionType' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: "A user-friendly description. Does not have to be unique, and it's changeable. \nAvoid entering confidential information.\n" maxLength: 400 minLength: 0 type: string x-default-description: 'null' displayName: description: "A user-friendly name. Does not have to be unique, and it's changeable. \nAvoid entering confidential information.\n" maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. \nFor more information, see Resource Tags. Example: {\"Department\": \"Finance\"}\n" type: object id: description: The OCID of the connection being referenced. maxLength: 255 minLength: 1 type: string ingressIps: description: List of ingress IP addresses from where to connect to this connection's privateIp. items: $ref: '#/components/schemas/IngressIpDetails' type: array keyId: description: The OCID of the key used in cryptographic operations. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: 'The message describing the current state of the connection''s lifecycle in detail. For example, can be used to provide actionable information for a connection in a Failed state. ' type: string lifecycleState: description: The Connection's current lifecycle state. enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED type: string nsgIds: description: 'An array of Network Security Group OCIDs used to define network access for Connections. ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array password: description: 'The password (credential) used when creating or updating this resource. ' format: password maxLength: 255 minLength: 0 type: string privateEndpointId: description: The OCID of the resource being referenced. maxLength: 255 minLength: 1 type: string replicationPassword: description: 'The password (credential) used when creating or updating this resource. ' format: password maxLength: 255 minLength: 0 type: string replicationUsername: description: 'The username (credential) used when creating or updating this resource. ' maxLength: 255 minLength: 0 type: string secretId: description: The OCID of the resource being referenced. maxLength: 255 minLength: 1 type: string subnetId: description: OCI resource ID. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The time when this resource was created. An RFC3339 formatted datetime string such as `2016-08-25T21:10:29.600Z`. ' format: date-time type: string timeUpdated: description: 'The time when this resource was updated. An RFC3339 formatted datetime string such as `2016-08-25T21:10:29.600Z`. ' format: date-time type: string username: description: 'The username (credential) used when creating or updating this resource. ' maxLength: 255 minLength: 0 type: string vaultId: description: OCI resource ID. maxLength: 255 minLength: 1 type: string required: - connectionType - id - displayName - compartmentId - lifecycleState - timeCreated - timeUpdated - username type: object AdvisorReportCheckObjectsCollection: description: 'Array of check objects. ' properties: items: description: 'Array of check objects. ' items: $ref: '#/components/schemas/AdvisorReportCheckObjectSummary' type: array required: - items type: object x-example: "{\n \"items\" : [\n {\n \"fields\": {\n \"OWNER\": \"FUSION\",\n \"COLUMN_NAME\": \"LEFT_ROWID\",\n \"TABLE_NAME\": \"pjs_sum_rowid\"\n },\n \"isExcluded\": true/false\n }\n ]\n}\n" AdvisorReportCheckObjectSummary: description: 'Database objects to migration. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object fields: additionalProperties: type: string type: object freeformTags: additionalProperties: type: string description: "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. \nFor more information, see Resource Tags. Example: {\"Department\": \"Finance\"}\n" type: object isExcluded: description: 'If the object was excluded from migration, then it is true. ' type: boolean systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object required: - fields - isExcluded type: object x-example: "{\n \"fields\": {\n \"OWNER\": \"FUSION\",\n \"COLUMN_NAME\": \"LEFT_ROWID\",\n \"TABLE_NAME\": \"pjs_sum_rowid\"\n },\n \"isExcluded\": true/false\n}\n" Assessment: description: Assessment resource discriminator: propertyName: databaseCombination properties: acceptableDowntime: description: Time allowed for the application downtime. enum: - LESS_THAN_10_MINUTES - LESS_THAN_1_HOUR - LESS_THAN_4_HOURS - LESS_THAN_8_HOURS - LESS_THAN_12_HOURS - LESS_THAN_1_DAY - LESS_THAN_2_DAYS - MORE_THAN_2_DAYS type: string x-obmcs-top-level-enum: '#/definitions/AcceptableDowntime' assessmentMigrationType: description: The migration type of the migration to be performed. enum: - ONLINE - ONLINE_STANDBY - OFFLINE type: string x-obmcs-top-level-enum: '#/definitions/AssessmentMigrationTypes' compartmentId: description: The OCID of the resource being referenced. maxLength: 255 minLength: 1 type: string creationType: description: The type of assessment creation. enum: - CREATE_ONLY - CREATE_AND_RUN_ASSESSORS type: string x-obmcs-top-level-enum: '#/definitions/CreationType' databaseCombination: description: 'The combination of source and target databases participating in a migration. Example: ORACLE means the migration is meant for migrating Oracle source and target databases. ' enum: - MYSQL - ORACLE type: string x-obmcs-top-level-enum: '#/definitions/DatabaseCombination' databaseDataSize: description: The size of a source database. enum: - LESS_THAN_1GB - GB_1_10 - GB_10_50 - GB_50_100 - GB_100_500 - GB_500_TB_1 - TB_1_3 - TB_3_10 - TB_10_50 - GREATER_THAN_50TB type: string x-obmcs-top-level-enum: '#/definitions/DatabaseDataSize' ddlExpectation: description: DDL expectation values. enum: - DDL_EXPECTED - DDL_NOT_EXPECTED type: string x-obmcs-top-level-enum: '#/definitions/DdlExpectation' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: "A user-friendly description. Does not have to be unique, and it's changeable. \nAvoid entering confidential information.\n" maxLength: 400 minLength: 0 type: string x-default-description: 'null' displayName: description: "A user-friendly name. Does not have to be unique, and it's changeable. \nAvoid entering confidential information.\n" maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. \nFor more information, see Resource Tags. Example: {\"Department\": \"Finance\"}\n" type: object id: description: The OCID of the resource being referenced. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the Assessment resource. enum: - CREATING - UPDATING - ACTIVE - SUCCEEDED - IN_PROGRESS - NEEDS_ATTENTION - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/AssessmentLifecycleStates' migrationId: description: The OCID of the resource being referenced. maxLength: 255 minLength: 1 type: string networkSpeedMegabitPerSecond: description: A network speed in Megabits per second. enum: - MBPS_10 - MBPS_100 - MBPS_1000 - MBPS_2500 - MBPS_5000 - MBPS_10000 type: string x-obmcs-top-level-enum: '#/definitions/NetworkSpeedMegabitPerSecond' sourceDatabaseConnection: $ref: '#/components/schemas/SourceAssessmentConnection' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object targetDatabaseConnection: $ref: '#/components/schemas/TargetAssessmentConnection' timeCreated: description: 'An RFC3339 formatted datetime string such as `2016-08-25T21:10:29.600Z`. ' format: date-time type: string timeUpdated: description: 'An RFC3339 formatted datetime string such as `2016-08-25T21:10:29.600Z`. ' format: date-time type: string required: - id - databaseCombination - displayName - compartmentId - sourceDatabaseConnection - targetDatabaseConnection - networkSpeedMegabitPerSecond - acceptableDowntime - databaseDataSize - ddlExpectation - creationType - timeCreated - lifecycleState type: object UpdateMigrationDetails: description: Common Update Migration details. discriminator: propertyName: databaseCombination properties: databaseCombination: description: 'The combination of source and target databases participating in a migration. Example: ORACLE means the migration is meant for migrating Oracle source and target databases. ' enum: - MYSQL - ORACLE type: string x-obmcs-top-level-enum: '#/definitions/DatabaseCombination' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: "A user-friendly description. Does not have to be unique, and it's changeable. \nAvoid entering confidential information.\n" maxLength: 400 minLength: 0 type: string x-default-description: 'null' displayName: description: "A user-friendly name. Does not have to be unique, and it's changeable. \nAvoid entering confidential information.\n" maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. \nFor more information, see Resource Tags. Example: {\"Department\": \"Finance\"}\n" type: object sourceDatabaseConnectionId: description: The OCID of the resource being referenced. maxLength: 255 minLength: 1 type: string targetDatabaseConnectionId: description: The OCID of the resource being referenced. maxLength: 255 minLength: 1 type: string type: description: 'The type of the migration to be performed. Example: ONLINE if no downtime is preferred for a migration. This method uses Oracle GoldenGate for replication. ' enum: - ONLINE - OFFLINE type: string x-obmcs-top-level-enum: '#/definitions/MigrationTypes' required: - databaseCombination type: object x-example: "Example of a Create Migration request body for an ONLINE migration type:\n{\n \"compartmentId\": \"ocid1.compartment.oc1..exampleunique_ID\",\n \"type\": \"ONLINE\",\n \"sourceDatabaseConnectionId\": \"ocid1.odms-connection.oc1..exampleunique_ID\",\n \"targetDatabaseConnectionId\": \"ocid1.odms-connection.oc1..exampleunique_ID\",\n \"freeformTags\": {\n \"Department\": \"Finance\"\n },\n \"definedTags\": {\n \"MyFirstNamespace\": {\n \"CostCenter\": \"SmartAlec\",\n \"Project\": \"42\",\n \"CreatedBy\": \"SmartAlec\",\n \"CreatedDate\": \"9/21/2017T14:00\"\n }\n }\n}\n" CreateMigrationDetails: description: Common Migration details. discriminator: propertyName: databaseCombination properties: assessmentId: description: The OCID of the resource being referenced. maxLength: 255 minLength: 1 type: string compartmentId: description: The OCID of the resource being referenced. maxLength: 255 minLength: 1 type: string databaseCombination: description: 'The combination of source and target databases participating in a migration. Example: ORACLE means the migration is meant for migrating Oracle source and target databases. ' enum: - MYSQL - ORACLE type: string x-obmcs-top-level-enum: '#/definitions/DatabaseCombination' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: "A user-friendly description. Does not have to be unique, and it's changeable. \nAvoid entering confidential information.\n" maxLength: 400 minLength: 0 type: string x-default-description: 'null' displayName: description: "A user-friendly name. Does not have to be unique, and it's changeable. \nAvoid entering confidential information.\n" maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. \nFor more information, see Resource Tags. Example: {\"Department\": \"Finance\"}\n" type: object sourceDatabaseConnectionId: description: The OCID of the resource being referenced. maxLength: 255 minLength: 1 type: string targetDatabaseConnectionId: description: The OCID of the resource being referenced. maxLength: 255 minLength: 1 type: string type: description: 'The type of the migration to be performed. Example: ONLINE if no downtime is preferred for a migration. This method uses Oracle GoldenGate for replication. ' enum: - ONLINE - OFFLINE type: string x-obmcs-top-level-enum: '#/definitions/MigrationTypes' required: - compartmentId - databaseCombination - type type: object x-example: "Example of a Create Migration request body for an ONLINE migration type:\n{\n \"compartmentId\": \"ocid1.compartment.oc1..exampleunique_ID\",\n \"type\": \"ONLINE\",\n \"sourceDatabaseConnectionId\": \"ocid1.odms-connection.oc1..exampleunique_ID\",\n \"targetDatabaseConnectionId\": \"ocid1.odms-connection.oc1..exampleunique_ID\",\n \"freeformTags\": {\n \"Department\": \"Finance\"\n },\n \"definedTags\": {\n \"MyFirstNamespace\": {\n \"CostCenter\": \"SmartAlec\",\n \"Project\": \"42\",\n \"CreatedBy\": \"SmartAlec\",\n \"CreatedDate\": \"9/21/2017T14:00\"\n }\n }\n}\n" UpdateAdvisorReportCheckDetails: description: 'Pre-Migration extended advisor report check item update. ' properties: isReviewed: description: 'User flag for advisor report check. ' type: boolean required: - isReviewed type: object x-example: "{\n \"isReviewed\": \"true\"\n}\n" UnsupportedDatabaseObject: description: 'Database objects to exclude from migration ' properties: objectName: description: 'Name of the object (regular expression is allowed) ' type: string owner: description: 'Owner of the object (regular expression is allowed) ' type: string type: description: 'Type of unsupported object ' enum: - GOLDEN_GATE type: string required: - owner - objectName type: object x-example: "{\n \"type\": \"GOLDEN_GATE\",\n \"owner\": \"user\",\n \"objectName\": \"exampleObj\"\n}\n" IngressIpDetails: description: Private Endpoint IP Addresses created in the customer's subnet. properties: ingressIp: description: A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet. maxLength: 46 minLength: 1 type: string required: - ingressIp type: object AffectedObjectsCollection: description: Array of check objects. properties: items: description: Items in collection. items: $ref: '#/components/schemas/AdvisorReportCheckObjectSummary' type: array required: - items type: object CreateConnectionDetails: description: The information about a new Connection. discriminator: propertyName: connectionType properties: compartmentId: description: The OCID of the compartment. maxLength: 255 minLength: 1 type: string connectionType: description: Defines the type of connection. For example, ORACLE. enum: - MYSQL - ORACLE type: string x-obmcs-top-level-enum: '#/definitions/ConnectionType' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: "A user-friendly description. Does not have to be unique, and it's changeable. \nAvoid entering confidential information.\n" maxLength: 400 minLength: 0 type: string x-default-description: 'null' displayName: description: "A user-friendly name. Does not have to be unique, and it's changeable. \nAvoid entering confidential information.\n" maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. \nFor more information, see Resource Tags. Example: {\"Department\": \"Finance\"}\n" type: object keyId: description: The OCID of the key used in cryptographic operations. maxLength: 255 minLength: 1 type: string nsgIds: description: 'An array of Network Security Group OCIDs used to define network access for Connections. ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array password: description: 'The password (credential) used when creating or updating this resource. ' format: password maxLength: 255 minLength: 0 type: string replicationPassword: description: 'The password (credential) used when creating or updating this resource. ' format: password maxLength: 255 minLength: 0 type: string replicationUsername: description: 'The username (credential) used when creating or updating this resource. ' maxLength: 255 minLength: 0 type: string subnetId: description: OCI resource ID. maxLength: 255 minLength: 1 type: string username: description: 'The username (credential) used when creating or updating this resource. ' maxLength: 255 minLength: 0 type: string vaultId: description: OCI resource ID. maxLength: 255 minLength: 1 type: string required: - connectionType - displayName - compartmentId - username - password - vaultId - keyId type: object JobSummary: description: 'Job description ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: 'Name of the job. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. \nFor more information, see Resource Tags. Example: {\"Department\": \"Finance\"}\n" type: object id: description: 'The OCID of the Migration Job. ' maxLength: 255 minLength: 1 type: string lifecycleDetails: description: 'A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. ' type: string lifecycleState: description: 'The current state of the migration Deployment. ' enum: - ACCEPTED - IN_PROGRESS - UNKNOWN - TERMINATED - FAILED - SUCCEEDED - WAITING - CANCELING - CANCELED type: string x-obmcs-top-level-enum: '#/definitions/JobLifecycleStates' migrationId: description: 'The OCID of the Migration that this job belongs to. ' maxLength: 255 minLength: 1 type: string progress: $ref: '#/components/schemas/MigrationJobProgressSummary' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The time the Migration Job was created. An RFC3339 formatted datetime string ' format: date-time type: string timeUpdated: description: 'The time the Migration Job was last updated. An RFC3339 formatted datetime string ' format: date-time type: string type: description: 'The job type. ' enum: - EVALUATION - MIGRATION type: string x-obmcs-top-level-enum: '#/definitions/JobTypes' required: - id - displayName - migrationId - type - timeCreated - lifecycleState type: object x-example: "{\n \"id\": \"ocid1.odms-job.oc1..exampleunique_ID\",\n \"migrationId\": \"ocid1.odms-migration.oc1..exampleunique_ID\",\n \"displayName\": \"jobName\",\n \"type\": \"MIGRATION\",\n \"timeCreated\": \"2020-08-03T16:46:26.550Z\",\n \"timeUpdated\": \"2020-08-03T16:46:26.550Z\",\n \"progress\": {\n \"currentStatus\": \"STARTED\",\n \"currentPhase\": \"ZDM_VALIDATE_TGT\",\n \"jobProgreess\": 15\n },\n \"lifecycleState\": \"IN_PROGRESS\",\n \"lifecycleDetails\": \"Target Database checks in progress.\",\n \"freeformTags\": {\"Department\": \"Finance\"},\n \"definedTags\":\n {\n \"MyFirstNamespace\":\n {\n \"CostCenter\": \"SmartAlec\",\n \"Project\": \"42\",\n \"CreatedBy\": \"SmartAlec\",\n \"CreatedDate\": \"9/21/2017T14:00\"\n }\n }\n}\n" MigrationPhaseCollection: description: 'Results of a Migration Phase search. Contains a collection of valid ODMS Job Phases. ' properties: items: description: 'Items in collection. ' items: $ref: '#/components/schemas/MigrationPhaseSummary' type: array required: - items type: object x-example: "{\n \"items\": [\n {\"name\": \"VALIDATE\", \"supportedActions\": [WAIT]}\n {\"name\": \"PREPARE_INITIAL_LOAD\", \"supportedActions\": [WAIT]},\n {\"name\": \"PREPARE_REPLICATION\", \"supportedActions\": [WAIT]},\n {\"name\": \"INITIAL_LOAD_EXPORT\", \"supportedActions\": [WAIT], \"recommendedAction\": \"WAIT\"},\n {\"name\": \"DATA_UPLOAD\", \"supportedActions\": [WAIT], \"recommendedAction\": \"WAIT\"},\n {\"name\": \"INITIAL_LOAD_IMPORT\",\"supportedActions\": [WAIT], \"recommendedAction\": \"WAIT\"},\n {\"name\": \"POST_INITIAL_LOAD\", \"supportedActions\": [WAIT], \"recommendedAction\": \"WAIT\"},\n {\"name\": \"MONITOR_REPLICATION_LAG\",\"supportedActions\": [WAIT], recommendedAction: \"WAIT\"},\n {\"name\": \"SWITCHOVER\", \"supportedActions\": [WAIT], recommendedAction: \"WAIT\"},\n {\"name\": \"CLEANUP\", \"supportedActions\": [WAIT]}\n ]\n}\n" ExcludedObjectSummaryCollection: description: 'Results of a Job''s Exclude objects output listing. Contains ExcludedObjectSummary items. ' properties: items: description: 'Items in collection. ' items: $ref: '#/components/schemas/ExcludedObjectSummary' type: array required: - items type: object x-example: "{\n \"items\": [\n {\n \"owner\" : \"SYS\",\n \"object\" : \"ABC1\",\n \"type\" : \"TABLE\",\n \"reasonCategory\" : \"USER_EXCLUDED\"\n \"sourceRule\" : \"(owner,objectName,objectType)\"\n },\n {\n \"owner\" : \"AQ$_SYS\",\n \"object\" : \"TSSCAN\",\n \"type\" : \"TABLE\",\n \"reasonCategory\" : \"GG_UNSUPPORTED\"\n \"sourceRule\" : null\n }\n ]\n}\n" DiagnosticsResult: description: 'Result from Database Connection Diagnostic action. ' properties: databaseInformation: $ref: '#/components/schemas/DatabaseInformation' error: $ref: '#/components/schemas/ResultError' resultType: description: 'Type of the Result (i.e. Success or Failure). ' enum: - SUCCEEDED - FAILED - WARNING - TIMED_OUT type: string x-obmcs-top-level-enum: '#/definitions/ResultType' required: - resultType type: object x-example: "{\n \"resultType\": FAILED,\n \"error\": {\n \"code\": \"DMS-0003\",\n \"message\": \"The database server is not reachable\",\n \"issue\": \"The connection to the database server was not established. \",\n \"action\": \"Verify the provided ip/host and port are correct and complete, also verify the port is open for connections.\"\n } \n}\n" AdvisorCheckSummary: description: 'Pre-Migration extended advisor report summary. ' properties: blockerResultsTotalCount: description: 'Number of BLOCKER results in the extended advisor report. ' type: integer fatalResultsTotalCount: description: 'Number of FATAL results in the extended advisor report. ' type: integer informationalResultsTotalCount: description: 'Number of INFORMATIONAL results in the extended advisor report. ' type: integer passResultsTotalCount: description: 'Number of PASS results in the extended advisor report. ' type: integer warningResultsTotalCount: description: 'Number of WARNING results in the extended advisor report. ' type: integer required: - passResultsTotalCount - informationalResultsTotalCount - warningResultsTotalCount - blockerResultsTotalCount - fatalResultsTotalCount type: object x-example: "{\n \"passResultsTotalCount\": ###,\n \"informationalResultsTotalCount\": ###,\n \"warningResultsTotalCount\": ###,\n \"blockerResultsTotalCount\": ###,\n \"fatalResultsTotalCount\": ###\n}\n" JobOutputSummaryCollection: description: 'Results of a Job output listing. Contains JobOutputSummary items. ' properties: items: description: 'Items in collection. ' items: $ref: '#/components/schemas/JobOutputSummary' type: array required: - items type: object x-example: "{\n \"items\": [\n {\n \"message\": \"nodeName.domain.com: Audit ID: 6\"\n },\n {\n \"message\": \"nnodeName.domain.com: Creating a new ACFS file system for image \\\"DB_Image1\\\"\"\n }\n ]\n}\n" UpdateAssessmentDetails: description: Common Update Assessment details. discriminator: propertyName: databaseCombination properties: acceptableDowntime: description: Time allowed for the application downtime. enum: - LESS_THAN_10_MINUTES - LESS_THAN_1_HOUR - LESS_THAN_4_HOURS - LESS_THAN_8_HOURS - LESS_THAN_12_HOURS - LESS_THAN_1_DAY - LESS_THAN_2_DAYS - MORE_THAN_2_DAYS type: string x-obmcs-top-level-enum: '#/definitions/AcceptableDowntime' creationType: description: The type of assessment creation. enum: - CREATE_ONLY - CREATE_AND_RUN_ASSESSORS type: string x-obmcs-top-level-enum: '#/definitions/CreationType' databaseCombination: description: 'The combination of source and target databases participating in a migration. Example: ORACLE means the migration is meant for migrating Oracle source and target databases. ' enum: - MYSQL - ORACLE type: string x-obmcs-top-level-enum: '#/definitions/DatabaseCombination' databaseDataSize: description: The size of a source database. enum: - LESS_THAN_1GB - GB_1_10 - GB_10_50 - GB_50_100 - GB_100_500 - GB_500_TB_1 - TB_1_3 - TB_3_10 - TB_10_50 - GREATER_THAN_50TB type: string x-obmcs-top-level-enum: '#/definitions/DatabaseDataSize' ddlExpectation: description: DDL expectation values. enum: - DDL_EXPECTED - DDL_NOT_EXPECTED type: string x-obmcs-top-level-enum: '#/definitions/DdlExpectation' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: "A user-friendly description. Does not have to be unique, and it's changeable. \nAvoid entering confidential information.\n" maxLength: 400 minLength: 0 type: string x-default-description: 'null' displayName: description: "A user-friendly name. Does not have to be unique, and it's changeable. \nAvoid entering confidential information.\n" maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. \nFor more information, see Resource Tags. Example: {\"Department\": \"Finance\"}\n" type: object networkSpeedMegabitPerSecond: description: A network speed in Megabits per second. enum: - MBPS_10 - MBPS_100 - MBPS_1000 - MBPS_2500 - MBPS_5000 - MBPS_10000 type: string x-obmcs-top-level-enum: '#/definitions/NetworkSpeedMegabitPerSecond' sourceDatabaseConnection: $ref: '#/components/schemas/SourceAssessmentConnection' targetDatabaseConnection: $ref: '#/components/schemas/TargetAssessmentConnection' required: - databaseCombination type: object DatabaseConnectionTypeSummary: description: Connection type e.g. ORACLE and array of technology type objects. properties: connectionType: description: Defines the type of connection. For example, ORACLE. enum: - MYSQL - ORACLE type: string x-obmcs-top-level-enum: '#/definitions/ConnectionType' technologyTypes: description: Array of technology type objects items: $ref: '#/components/schemas/DatabaseTechnologyType' maxLength: 255 minLength: 0 type: array required: - connectionType type: object WorkRequestSummary: description: 'A summary of the status of a work request. ' properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing this work request. ' maxLength: 255 minLength: 1 type: string id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. ' maxLength: 255 minLength: 1 type: string operationType: description: 'The asynchronous operation tracked by this work request. ' type: string percentComplete: description: 'The percentage complete of the operation tracked by this work request. ' format: float type: number status: description: 'The status of the work request. ' enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED type: string timeAccepted: description: 'The date and time the work request was created, in the format defined by RFC3339. ' format: date-time type: string timeFinished: description: 'The date and time the work request reached a terminal state, either `FAILED` or `SUCCEEDED`. Format is defined by RFC3339. ' format: date-time type: string timeStarted: description: 'The date and time the work request transitioned from `ACCEPTED` to `IN_PROGRESS`, in the format defined by RFC3339. ' format: date-time type: string required: - operationType - status - id - compartmentId - percentComplete - timeAccepted x-example: "{\n \"operationType\":\"LaunchInstancesInPool\",\n \"status\":\"SUCCEEDED\",\n \"id\":\"ocid1.coreservicesworkrequest.oc1.phx.exampleunique_ID\",\n \"compartmentId\":\"ocid1.tenancy.oc1..exampleuniqueID\",\n \"percentComplete\":100.0,\n \"timeAccepted\":\"2019-05-07T00:50:03.248Z\",\n \"timeStarted\":\"2019-05-07T00:50:03.374Z\",\n \"timeFinished\":\"2019-05-07T00:52:05.704Z\"\n}\n" StartMigrationDetails: description: Parameters to specify to a Migration job operation. properties: waitAfter: description: 'Name of a migration phase. The Job will wait after executing this phase until the Resume Job endpoint is called. ' enum: - ODMS_VALIDATE_TGT - ODMS_VALIDATE_SRC - ODMS_VALIDATE_PREMIGRATION_ADVISOR - ODMS_VALIDATE_GG_HUB - ODMS_VALIDATE_DATAPUMP_SETTINGS - ODMS_VALIDATE_DATAPUMP_SETTINGS_SRC - ODMS_VALIDATE_DATAPUMP_SETTINGS_TGT - ODMS_VALIDATE_DATAPUMP_SRC - ODMS_VALIDATE_DATAPUMP_ESTIMATE_SRC - ODMS_FETCH_METADATA_SRC - ODMS_FETCH_METADATA_TGT - ODMS_VALIDATE - ODMS_PREPARE - ODMS_INITIALIZE_REPLICATION_INFRASTRUCTURE - ODMS_INITIAL_LOAD_EXPORT - ODMS_DATA_UPLOAD - ODMS_METADATA_TRANSFER - ODMS_INITIAL_LOAD_EXPORT_DATA_UPLOAD - ODMS_INITIAL_LOAD_IMPORT - ODMS_POST_INITIAL_LOAD - ODMS_PREPARE_REPLICATION_TARGET - ODMS_MONITOR_REPLICATION_LAG - ODMS_SWITCHOVER - ODMS_CLEANUP type: string x-obmcs-top-level-enum: '#/definitions/OdmsJobPhases' type: object x-example: "{\n \"waitAfter\": \"ZDM_PREPARE_DATAPUMP\"\n}\n" PhaseStatus: description: 'Job phase status details. ' properties: action: description: 'The text describing the action required to fix the issue ' type: string durationInMs: description: 'Duration of the phase in milliseconds ' type: integer editableParameterFiles: description: 'Attribute that returns an array of names and types of GoldenGate configuration files that are available for read or update. ' items: enum: - EXTRACT - REPLICAT type: string x-obmcs-top-level-enum: '#/definitions/JobParameterFileVersionKind' maxItems: 1 type: array extract: description: 'Summary of phase status results. ' items: $ref: '#/components/schemas/PhaseExtractEntry' type: array groupDisplayName: description: 'Job Phase group display name e.g. ''Step 1: Migration'' ' maxLength: 100 minLength: 1 type: string isAdvisorReportAvailable: description: 'True if a Pre-Migration Advisor report is available for this phase. False or null if no report is available. ' type: boolean isSuspendAvailable: description: 'This is returned as true if the current phase can be suspended. ' type: boolean issue: description: 'The text describing the root cause of the reported issue ' type: string logLocation: $ref: '#/components/schemas/LogLocationBucketDetails' name: description: 'Phase name ' enum: - ODMS_VALIDATE_TGT - ODMS_VALIDATE_SRC - ODMS_VALIDATE_PREMIGRATION_ADVISOR - ODMS_VALIDATE_GG_HUB - ODMS_VALIDATE_DATAPUMP_SETTINGS - ODMS_VALIDATE_DATAPUMP_SETTINGS_SRC - ODMS_VALIDATE_DATAPUMP_SETTINGS_TGT - ODMS_VALIDATE_DATAPUMP_SRC - ODMS_VALIDATE_DATAPUMP_ESTIMATE_SRC - ODMS_FETCH_METADATA_SRC - ODMS_FETCH_METADATA_TGT - ODMS_VALIDATE - ODMS_PREPARE - ODMS_INITIALIZE_REPLICATION_INFRASTRUCTURE - ODMS_INITIAL_LOAD_EXPORT - ODMS_DATA_UPLOAD - ODMS_METADATA_TRANSFER - ODMS_INITIAL_LOAD_EXPORT_DATA_UPLOAD - ODMS_INITIAL_LOAD_IMPORT - ODMS_POST_INITIAL_LOAD - ODMS_PREPARE_REPLICATION_TARGET - ODMS_MONITOR_REPLICATION_LAG - ODMS_SWITCHOVER - ODMS_CLEANUP type: string x-obmcs-top-level-enum: '#/definitions/OdmsJobPhases' progress: description: 'Percent progress of job phase. ' type: integer status: description: 'Phase status ' enum: - PENDING - STARTED - COMPLETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/JobPhaseStatus' required: - name - status - durationInMs type: object x-example: "{\n \"name\": \"ZDM_DATAPUMP_EXPORT\",\n \"status\": \"STARTED\",\n \"durationInMs\": 600000,\n \"isAdvisorReportAvailable\": true,\n \"issue\": \"The target autonomous database is not accessible\",\n \"action\": \"Review security lists\",\n \"extract\": [\n {\n \"type\": \"ERROR\",\n \"message\": \"PRGD-1019 : creation of Data Pump job \\\"ZDM_0_EXPORT_0000\\\" with operation type \\\"EXPORT\\\" failed\"\n }\n ],\n \"logLocation\": {\n \"bucketName\": \"name\",\n \"namespace\": \"namespace\",\n \"objectName\": \"ZDM_0_DP_EXPORT_0000.log\"\n },\n \"isSuspendAvailable\": true,\n \"editableParameterFiles\": [\"EXTRACT\"],\n \"progress\": 20\n}\n" CreateAssessmentDetails: description: Common Create Assessment details. discriminator: propertyName: databaseCombination properties: acceptableDowntime: description: Time allowed for the application downtime. enum: - LESS_THAN_10_MINUTES - LESS_THAN_1_HOUR - LESS_THAN_4_HOURS - LESS_THAN_8_HOURS - LESS_THAN_12_HOURS - LESS_THAN_1_DAY - LESS_THAN_2_DAYS - MORE_THAN_2_DAYS type: string x-obmcs-top-level-enum: '#/definitions/AcceptableDowntime' compartmentId: description: The OCID of the resource being referenced. maxLength: 255 minLength: 1 type: string creationType: description: The type of assessment creation. enum: - CREATE_ONLY - CREATE_AND_RUN_ASSESSORS type: string x-obmcs-top-level-enum: '#/definitions/CreationType' databaseCombination: description: 'The combination of source and target databases participating in a migration. Example: ORACLE means the migration is meant for migrating Oracle source and target databases. ' enum: - MYSQL - ORACLE type: string x-obmcs-top-level-enum: '#/definitions/DatabaseCombination' databaseDataSize: description: The size of a source database. enum: - LESS_THAN_1GB - GB_1_10 - GB_10_50 - GB_50_100 - GB_100_500 - GB_500_TB_1 - TB_1_3 - TB_3_10 - TB_10_50 - GREATER_THAN_50TB type: string x-obmcs-top-level-enum: '#/definitions/DatabaseDataSize' ddlExpectation: description: DDL expectation values. enum: - DDL_EXPECTED - DDL_NOT_EXPECTED type: string x-obmcs-top-level-enum: '#/definitions/DdlExpectation' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: "A user-friendly description. Does not have to be unique, and it's changeable. \nAvoid entering confidential information.\n" maxLength: 400 minLength: 0 type: string x-default-description: 'null' displayName: description: "A user-friendly name. Does not have to be unique, and it's changeable. \nAvoid entering confidential information.\n" maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. \nFor more information, see Resource Tags. Example: {\"Department\": \"Finance\"}\n" type: object networkSpeedMegabitPerSecond: description: A network speed in Megabits per second. enum: - MBPS_10 - MBPS_100 - MBPS_1000 - MBPS_2500 - MBPS_5000 - MBPS_10000 type: string x-obmcs-top-level-enum: '#/definitions/NetworkSpeedMegabitPerSecond' sourceDatabaseConnection: $ref: '#/components/schemas/SourceAssessmentConnection' targetDatabaseConnection: $ref: '#/components/schemas/TargetAssessmentConnection' required: - compartmentId - databaseCombination - networkSpeedMegabitPerSecond - acceptableDowntime - databaseDataSize - ddlExpectation - sourceDatabaseConnection - targetDatabaseConnection type: object PhaseExtractEntry: description: 'Job phase extract message. ' properties: message: description: 'Message in entry. ' type: string type: description: 'Type of extract. ' enum: - ERROR type: string x-obmcs-top-level-enum: '#/definitions/PhaseExtractTypes' required: - type - message type: object x-example: "{\n \"type\": \"ERROR\",\n \"message\": \"PRGD-1019 : creation of Data Pump job \\\"ZDM_6_IMPORT_1608684744491\\\" with operation type \\\"IMPORT\\\" failed\"\n}\n" DatabaseInformation: description: 'Database Information. ' properties: dataSizeInMBs: description: The total size of the database in megabytes. type: integer databaseName: description: The database name. type: string databaseVersion: description: The database version. type: string x-example: "{\n \"databaseName\": \"HR-0003\",\n \"databaseVersion\": \"Oracle Database 23ai Enterprise Edition Release 23.0.0.0.0\",\n \"dataSize\": 300\n}\n" CloneMigrationDetails: description: Customizable details when performing cloning of a migration. discriminator: propertyName: databaseCombination properties: assessmentId: description: The OCID of the resource being referenced. maxLength: 255 minLength: 1 type: string compartmentId: description: The OCID of the resource being referenced. maxLength: 255 minLength: 1 type: string databaseCombination: description: 'The combination of source and target databases participating in a migration. Example: ORACLE means the migration is meant for migrating Oracle source and target databases. ' enum: - MYSQL - ORACLE type: string x-obmcs-top-level-enum: '#/definitions/DatabaseCombination' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: "A user-friendly name. Does not have to be unique, and it's changeable. \nAvoid entering confidential information.\n" maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. \nFor more information, see Resource Tags. Example: {\"Department\": \"Finance\"}\n" type: object sourceDatabaseConnectionId: description: The OCID of the resource being referenced. maxLength: 255 minLength: 1 type: string targetDatabaseConnectionId: description: The OCID of the resource being referenced. maxLength: 255 minLength: 1 type: string required: - databaseCombination - sourceDatabaseConnectionId - targetDatabaseConnectionId type: object x-example: "{\n \"sourceDatabaseConnectionId\": \"ocid1.odms-connection.oc1..exampleunique_ID\",\n \"targetDatabaseConnectionId\": \"ocid1.odms-connection.oc1..exampleunique_ID\",\n \"freeformTags\": {\"Department\": \"Finance\"},\n \"definedTags\":\n {\n \"MyFirstNamespace\":\n {\n \"CostCenter\": \"SmartAlec\",\n \"Project\": \"42\",\n \"CreatedBy\": \"SmartAlec\",\n \"CreatedDate\": \"9/21/2017T14:00\"\n }\n }\n}\n" MigrationParameterBase: description: Migration parameter base object. properties: dataType: description: Parameter data type. enum: - STRING - INTEGER - FLOAT - BOOLEAN type: string x-obmcs-top-level-enum: '#/definitions/AdvancedParameterDataTypes' name: description: Parameter name. type: string required: - name - dataType type: object MigrationPhaseSummary: description: 'Migration Phase Summary of details. ' properties: name: description: 'ODMS Job phase name ' enum: - ODMS_VALIDATE_TGT - ODMS_VALIDATE_SRC - ODMS_VALIDATE_PREMIGRATION_ADVISOR - ODMS_VALIDATE_GG_HUB - ODMS_VALIDATE_DATAPUMP_SETTINGS - ODMS_VALIDATE_DATAPUMP_SETTINGS_SRC - ODMS_VALIDATE_DATAPUMP_SETTINGS_TGT - ODMS_VALIDATE_DATAPUMP_SRC - ODMS_VALIDATE_DATAPUMP_ESTIMATE_SRC - ODMS_FETCH_METADATA_SRC - ODMS_FETCH_METADATA_TGT - ODMS_VALIDATE - ODMS_PREPARE - ODMS_INITIALIZE_REPLICATION_INFRASTRUCTURE - ODMS_INITIAL_LOAD_EXPORT - ODMS_DATA_UPLOAD - ODMS_METADATA_TRANSFER - ODMS_INITIAL_LOAD_EXPORT_DATA_UPLOAD - ODMS_INITIAL_LOAD_IMPORT - ODMS_POST_INITIAL_LOAD - ODMS_PREPARE_REPLICATION_TARGET - ODMS_MONITOR_REPLICATION_LAG - ODMS_SWITCHOVER - ODMS_CLEANUP type: string x-obmcs-top-level-enum: '#/definitions/OdmsJobPhases' recommendedAction: description: 'Action recommended for this phase. If not included in the response, there is no recommended action for the phase. ' enum: - WAIT type: string x-obmcs-top-level-enum: '#/definitions/OdmsPhaseActions' supportedActions: description: 'Array of actions for the corresponding phase. Empty array would indicate there is no supported action for the phase. ' items: $ref: '#/components/schemas/OdmsPhaseActions' type: array required: - name - supportedActions type: object x-example: '{"name": "MONITOR_REPLICATION_LAG", "supportedActions": [WAIT], recommendedAction: "WAIT"} ' AdvisorReportCheckSummary: description: 'Pre-Migration extended advisor report check item. ' properties: action: description: 'Fixing the issue. ' maxLength: 4000 minLength: 1 type: string columns: description: 'Array of the column of the objects table. ' items: $ref: '#/components/schemas/AdvisorReportCheckColumn' type: array displayName: description: 'Pre-Migration сheck display name. ' maxLength: 255 minLength: 1 type: string fixupScriptLocation: description: 'The path to the fixup script for this check. ' maxLength: 255 minLength: 1 type: string impact: description: 'Impact of the issue on data migration. ' maxLength: 4000 minLength: 1 type: string isExclusionAllowed: description: 'If false, objects cannot be excluded from migration. ' type: boolean isReviewed: description: 'User flag for advisor report check. ' type: boolean issue: description: 'Description of the issue. ' maxLength: 4000 minLength: 1 type: string key: description: 'Pre-Migration сheck id. ' maxLength: 4000 minLength: 1 type: string metadata: $ref: '#/components/schemas/ObjectMetadata' objectCount: description: 'Number of database objects to migrate. ' type: integer resultType: description: 'Pre-Migration advisor result. ' enum: - FATAL - BLOCKER - WARNING - INFORMATIONAL - PASS type: string x-obmcs-top-level-enum: '#/definitions/AdvisorResults' required: - key - displayName - resultType - isReviewed - issue - impact - action - isExclusionAllowed - columns - objectCount type: object x-example: "{\n \"key\": \"has_columns_of_rowid_type\"\n \"displayName\": \"Has columns of rowid type\"\n \"resultType\": \"enum value of result\" (i.e. BLOCKER, FATAL, WARNING, etc...),\n \"isReviewed\": \"User flag for advisor report check\",\n \"issue\": \"The ROWID data type is not enabled by default in Dedicated Infrastructure\",\n \"impact\": \"By default, columns with ROWID data type cannot be migrated to ATPD or ADWD.\",\n \"action\": \"Columns with Media data types are not allowed in Autonomous Database\",\n \"metadata\": {\n \"schemaOwnerColumn\": \"OWNER\",\n \"objectNameColumn\": \"TABLE_NAME\",\n \"objectTypeFixed\": \"TABLE\",\n \"objectTypeColumn\": \"\",\n },\n \"fixupScriptLocation\": \"/path/\",\n \"isExclusionAllowed\": true/false,\n \"columns\": [\n {\n \"id\": \"TABLE_NAME\",\n \"displayName\": \"Table\",\n }\n ],\n \"objectCount\": ###\n}\n" TargetAssessmentConnection: description: Target Assessment Connection object properties: connectionType: description: Defines the type of connection. For example, ORACLE. enum: - MYSQL - ORACLE type: string x-obmcs-top-level-enum: '#/definitions/ConnectionType' databaseVersion: description: The database version maxLength: 100 minLength: 1 type: string id: description: The OCID of the resource being referenced. maxLength: 255 minLength: 1 type: string technologySubType: description: Technology sub-type e.g. ADW_SHARED, ADW_DEDICATED, ATP_SHARED, ATP_DEDICATED maxLength: 100 minLength: 1 type: string technologyType: description: The technology type. enum: - OCI_AUTONOMOUS_DATABASE - OCI_MYSQL - ORACLE_DATABASE - ORACLE_EXADATA - AMAZON_RDS_ORACLE - AMAZON_AURORA_MYSQL - AMAZON_RDS_MYSQL - AZURE_MYSQL - GOOGLE_CLOUD_SQL_MYSQL - MYSQL_SERVER type: string x-obmcs-top-level-enum: '#/definitions/TechnologyType' type: object ParameterFileVersionCollection: description: The result of the request for Parameter Files. It contains a collection of ParameterFileVersionSummary properties: items: description: List of parameter file metadata items: $ref: '#/components/schemas/ParameterFileVersionSummary' maxItems: 8 minItems: 0 type: array required: - items type: object x-example: "{\n \"items\":\n [\n {\n \"name\": \"EXTNOWL9_ORIGINAL\",\n \"kind\": \"EXTRACT\",\n \"timeCreated\": \"2019-05-07T00:00:03.374Z\"\n },\n {\n \"name\": \"EXTNOWL9_20190507005045\",\n \"kind\": \"EXTRACT\",\n \"timeCreated\": \"2019-05-07T00:50:45.874Z\"\n },\n {\n \"name\": \"EXTNOWL9_2019050711532\",\n \"kind\": \"EXTRACT\",\n \"timeCreated\": \"2019-05-07T01:15:32.004Z\"\n },\n {\n \"name\": \"R4FAY_ORIGINAL\",\n \"kind\": \"REPLICAT\",\n \"timeCreated\": \"2019-05-07T02:75:34.425Z\"\n }\n ]\n}\n" AssessmentObjectCollection: description: Assessment Objects collection. discriminator: propertyName: databaseCombination properties: databaseCombination: description: 'The combination of source and target databases participating in a migration. Example: ORACLE means the migration is meant for migrating Oracle source and target databases. ' enum: - MYSQL - ORACLE type: string x-obmcs-top-level-enum: '#/definitions/DatabaseCombination' required: - databaseCombination type: object ChangeAssessmentCompartmentDetails: description: Details pertaining to change of an assessment's compartment. properties: compartmentId: description: The OCID of the resource being referenced. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object UpdateCheckActionUpdateObjectDetails: description: Details for UpdateCheckActionUpdateObject. discriminator: propertyName: kind properties: kind: default: LIST_OBJECTS description: 'Type of update advisor report check. Default kind is LIST_OBJECTS ' enum: - ALL_OBJECTS - LIST_OBJECTS type: string required: - kind type: object ParameterFileVersion: description: Details of a parameter file properties: content: description: The content in base64 encoded character string containing the value of the parameter file type: string description: description: Describes the current parameter file version type: string isCurrent: description: Return boolean true/false for the currently in-use parameter file (factory or a versioned file) type: boolean isFactory: description: Return true/false for whether the parameter file is oracle provided (Factory) type: boolean kind: description: Indicator of Parameter File 'kind' (for an EXTRACT or a REPLICAT) enum: - EXTRACT - REPLICAT type: string x-obmcs-top-level-enum: '#/definitions/JobParameterFileVersionKind' name: description: A unique name associated with the current migration/job and extract/replicat name type: string timeCreated: description: 'The time when this parameter file was applied on the process ' format: date-time type: string required: - name - kind - isCurrent - isFactory - timeCreated - content type: object x-example: "{\n \"name\": \"EXTNOWL9_ORIGINAL\",\n \"kind\": \"EXTRACT\",\n \"content\": \"RVhUUkFDVCBmaW5hbmNlXG5VU0VSSURBTElBUyB0aWdlcjFcbkxPR0FMTFNVUENPTFNcbk5DUllQVFRSQUlMIEFFUzE5MlxuRVhUVFJBSUwgL2dncy9kaXJkYXQvbHRcblNFUVVFTkNFIGhyLmVtcGxveWVlc19zZXE7XG5UQUJMRSBoci4q\",\n \"timeCreated\": \"2019-05-07T00:00:03.374Z\"\n}\n" CollectTracesData: description: Information regarding the DB trace and alert log collection properties: bucketName: description: 'Name of the bucket containing the file. ' maxLength: 255 minLength: 1 type: string collectTracesState: description: 'Status of trace collection process. ' enum: - IN_PROGRESS - SUCCEEDED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/CollectTracesStates' namespace: description: 'Object Storage namespace. ' maxLength: 255 minLength: 1 type: string objectName: description: 'Object name. ' maxLength: 255 minLength: 1 type: string required: - bucketName - namespace - objectName - collectTracesState type: object AssessorCheckSummaryCollection: description: Collection of assessor check summaries. properties: items: description: Items in collection. items: $ref: '#/components/schemas/AssessorCheckSummary' type: array required: - items type: object MigrationObjectTypeSummaryCollection: description: Results of a Migration Object Type listing. Contains MigrationObjectTypeSummary items. properties: items: description: Items in collection. items: $ref: '#/components/schemas/MigrationObjectTypeSummary' type: array required: - items type: object x-example: "Example of MigrationObjectTypeSummaryCollection response with one element:\n{\n \"items\": [\n {\n \"name\": \"STORED_PROCEDURE\"\n }\n ]\n}\n" MigrationObjectTypeSummary: description: Migration Object Type properties: name: description: Object type name type: string required: - name type: object x-example: '{"name": "STORED_PROCEDURE"} ' AssessmentCollection: description: Results of an Assessment search. Contains AssessmentSummary items. properties: items: description: Items in collection. items: $ref: '#/components/schemas/AssessmentSummary' type: array required: - items type: object ResumeJobDetails: description: 'Parameters to specify to resume a Migration Job. ' properties: waitAfter: description: 'Name of a migration phase. The Job will wait after executing this phase until Resume Job endpoint is called again. ' enum: - ODMS_VALIDATE_TGT - ODMS_VALIDATE_SRC - ODMS_VALIDATE_PREMIGRATION_ADVISOR - ODMS_VALIDATE_GG_HUB - ODMS_VALIDATE_DATAPUMP_SETTINGS - ODMS_VALIDATE_DATAPUMP_SETTINGS_SRC - ODMS_VALIDATE_DATAPUMP_SETTINGS_TGT - ODMS_VALIDATE_DATAPUMP_SRC - ODMS_VALIDATE_DATAPUMP_ESTIMATE_SRC - ODMS_FETCH_METADATA_SRC - ODMS_FETCH_METADATA_TGT - ODMS_VALIDATE - ODMS_PREPARE - ODMS_INITIALIZE_REPLICATION_INFRASTRUCTURE - ODMS_INITIAL_LOAD_EXPORT - ODMS_DATA_UPLOAD - ODMS_METADATA_TRANSFER - ODMS_INITIAL_LOAD_EXPORT_DATA_UPLOAD - ODMS_INITIAL_LOAD_IMPORT - ODMS_POST_INITIAL_LOAD - ODMS_PREPARE_REPLICATION_TARGET - ODMS_MONITOR_REPLICATION_LAG - ODMS_SWITCHOVER - ODMS_CLEANUP type: string x-obmcs-top-level-enum: '#/definitions/OdmsJobPhases' type: object x-example: "{\n \"waitAfter\": \"ZDM_PREPARE_DATAPUMP\"\n}\n" UpdateJobDetails: description: 'Update Job Details ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: 'Name of the job. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. \nFor more information, see Resource Tags. Example: {\"Department\": \"Finance\"}\n" type: object type: object x-example: "{\n \"displayName\": \"migrationJob-1\",\n}\n" UpdateConnectionDetails: description: The information to update a Connection. discriminator: propertyName: connectionType properties: connectionType: description: Defines the type of connection. For example, ORACLE. enum: - MYSQL - ORACLE type: string x-obmcs-top-level-enum: '#/definitions/ConnectionType' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: "A user-friendly description. Does not have to be unique, and it's changeable. \nAvoid entering confidential information.\n" maxLength: 400 minLength: 0 type: string x-default-description: 'null' displayName: description: "A user-friendly name. Does not have to be unique, and it's changeable. \nAvoid entering confidential information.\n" maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. \nFor more information, see Resource Tags. Example: {\"Department\": \"Finance\"}\n" type: object keyId: description: The OCID of the key used in cryptographic operations. maxLength: 255 minLength: 1 type: string nsgIds: description: 'An array of Network Security Group OCIDs used to define network access for Connections. ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array password: description: 'The password (credential) used when creating or updating this resource. ' format: password maxLength: 255 minLength: 0 type: string replicationPassword: description: 'The password (credential) used when creating or updating this resource. ' format: password maxLength: 255 minLength: 0 type: string replicationUsername: description: 'The username (credential) used when creating or updating this resource. ' maxLength: 255 minLength: 0 type: string subnetId: description: OCI resource ID. maxLength: 255 minLength: 0 type: string username: description: 'The username (credential) used when creating or updating this resource. ' maxLength: 255 minLength: 0 type: string vaultId: description: OCI resource ID. maxLength: 255 minLength: 1 type: string type: object MigrationParameterSummary: allOf: - $ref: '#/components/schemas/MigrationParameterBase' - type: object - properties: categoryDisplayName: description: Parameter category display name. type: string categoryName: description: Parameter category name. type: string databaseCombination: description: 'The combination of source and target databases participating in a migration. Example: ORACLE means the migration is meant for migrating Oracle source and target databases. ' enum: - MYSQL - ORACLE type: string x-obmcs-top-level-enum: '#/definitions/DatabaseCombination' defaultValue: description: Default value for a parameter. type: string description: description: Parameter name description. type: string displayName: description: Parameter display name. type: string docUrlLink: description: Parameter documentation URL link. type: string hintText: description: Hint text for parameter value. type: string maxValue: description: Parameter maximum value. format: float type: number migrationType: description: Migration Stage. enum: - ONLINE - OFFLINE type: string x-obmcs-top-level-enum: '#/definitions/MigrationTypes' minValue: description: Parameter minimum value. format: float type: number required: - databaseCombination - displayName - description - categoryName - categoryDisplayName - migrationType description: Migration parameter response object. MigrationJobProgressSummary: description: 'Summary of the progress of a Migration Job. ' properties: currentPhase: description: 'Current phase of the job. ' enum: - ODMS_VALIDATE_TGT - ODMS_VALIDATE_SRC - ODMS_VALIDATE_PREMIGRATION_ADVISOR - ODMS_VALIDATE_GG_HUB - ODMS_VALIDATE_DATAPUMP_SETTINGS - ODMS_VALIDATE_DATAPUMP_SETTINGS_SRC - ODMS_VALIDATE_DATAPUMP_SETTINGS_TGT - ODMS_VALIDATE_DATAPUMP_SRC - ODMS_VALIDATE_DATAPUMP_ESTIMATE_SRC - ODMS_FETCH_METADATA_SRC - ODMS_FETCH_METADATA_TGT - ODMS_VALIDATE - ODMS_PREPARE - ODMS_INITIALIZE_REPLICATION_INFRASTRUCTURE - ODMS_INITIAL_LOAD_EXPORT - ODMS_DATA_UPLOAD - ODMS_METADATA_TRANSFER - ODMS_INITIAL_LOAD_EXPORT_DATA_UPLOAD - ODMS_INITIAL_LOAD_IMPORT - ODMS_POST_INITIAL_LOAD - ODMS_PREPARE_REPLICATION_TARGET - ODMS_MONITOR_REPLICATION_LAG - ODMS_SWITCHOVER - ODMS_CLEANUP type: string x-obmcs-top-level-enum: '#/definitions/OdmsJobPhases' currentStatus: description: 'Current status of the job. ' enum: - PENDING - STARTED - COMPLETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/JobPhaseStatus' jobProgress: description: 'Job progress percentage (0 - 100) ' type: integer required: - currentPhase - currentStatus - jobProgress type: object x-example: "{\n \"currentStatus\": \"STARTED\",\n \"currentPhase\": \"ZDM_VALIDATE_TGT\",\n \"jobProgreess\": 15\n}\n" SourceAssessmentConnection: description: Source Assessment Connection object properties: id: description: The OCID of the resource being referenced. maxLength: 255 minLength: 1 type: string required: - id type: object WorkRequestLogEntry: description: 'A log message from executing an operation that is tracked by a work request. ' properties: message: description: 'A human-readable log message. ' type: string timestamp: description: 'The time the log message was written. An RFC3339 formatted datetime string ' format: date-time type: string required: - message - timestamp x-example: "{\n \"message\" : \"Powering on virtual machine.\",\n \"timestamp\" : \"2019-05-07T00:50:44.446Z\"\n}\n" ExcludedObjectSummary: description: 'Excluded object summary line. ' properties: object: description: 'Database object name. ' type: string owner: description: 'Database object owner. ' type: string reasonCategory: description: 'Reason category for object exclusion. ' enum: - ORACLE_MAINTAINED - GG_UNSUPPORTED - USER_EXCLUDED - MANDATORY_EXCLUDED - USER_EXCLUDED_TYPE type: string x-obmcs-top-level-enum: '#/definitions/ReasonKeywords' sourceRule: description: 'Reason for exclusion. ' type: string type: description: 'Database object type. ' type: string required: - owner - object - type - reasonCategory type: object x-example: "{\n \"owner\" : \"SYS\",\n \"object\" : \"ABC1\",\n \"type\" : \"TABLE\",\n \"reasonCategory\" : \"USER_EXCLUDED\"\n \"sourceRule\" : \"(owner,objectName,objectType)\"\n}\n" Migration: description: Migration resource discriminator: propertyName: databaseCombination properties: assessmentId: description: The OCID of the resource being referenced. maxLength: 255 minLength: 1 type: string compartmentId: description: The OCID of the resource being referenced. maxLength: 255 minLength: 1 type: string databaseCombination: description: 'The combination of source and target databases participating in a migration. Example: ORACLE means the migration is meant for migrating Oracle source and target databases. ' enum: - MYSQL - ORACLE type: string x-obmcs-top-level-enum: '#/definitions/DatabaseCombination' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: "A user-friendly description. Does not have to be unique, and it's changeable. \nAvoid entering confidential information.\n" maxLength: 400 minLength: 0 type: string x-default-description: 'null' displayName: description: "A user-friendly name. Does not have to be unique, and it's changeable. \nAvoid entering confidential information.\n" maxLength: 255 minLength: 1 type: string executingJobId: description: The OCID of the resource being referenced. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. \nFor more information, see Resource Tags. Example: {\"Department\": \"Finance\"}\n" type: object id: description: The OCID of the resource being referenced. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Additional status related to the execution and current state of the Migration. enum: - READY - ABORTING - VALIDATING - VALIDATED - ASSESSED - WAITING - MIGRATING - DONE type: string x-obmcs-top-level-enum: '#/definitions/MigrationStatus' lifecycleState: description: The current state of the Migration resource. enum: - CREATING - UPDATING - ACTIVE - IN_PROGRESS - ACCEPTED - SUCCEEDED - CANCELED - WAITING - NEEDS_ATTENTION - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/MigrationLifecycleStates' sourceDatabaseConnectionId: description: The OCID of the resource being referenced. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object targetDatabaseConnectionId: description: The OCID of the resource being referenced. maxLength: 255 minLength: 1 type: string timeCreated: description: 'An RFC3339 formatted datetime string such as `2016-08-25T21:10:29.600Z`. ' format: date-time type: string timeLastMigration: description: 'An RFC3339 formatted datetime string such as `2016-08-25T21:10:29.600Z`. ' format: date-time type: string timeUpdated: description: 'An RFC3339 formatted datetime string such as `2016-08-25T21:10:29.600Z`. ' format: date-time type: string type: description: 'The type of the migration to be performed. Example: ONLINE if no downtime is preferred for a migration. This method uses Oracle GoldenGate for replication. ' enum: - ONLINE - OFFLINE type: string x-obmcs-top-level-enum: '#/definitions/MigrationTypes' waitAfter: description: 'You can optionally pause a migration after a job phase. This property allows you to optionally specify the phase after which you can pause the migration. ' enum: - ODMS_VALIDATE_TGT - ODMS_VALIDATE_SRC - ODMS_VALIDATE_PREMIGRATION_ADVISOR - ODMS_VALIDATE_GG_HUB - ODMS_VALIDATE_DATAPUMP_SETTINGS - ODMS_VALIDATE_DATAPUMP_SETTINGS_SRC - ODMS_VALIDATE_DATAPUMP_SETTINGS_TGT - ODMS_VALIDATE_DATAPUMP_SRC - ODMS_VALIDATE_DATAPUMP_ESTIMATE_SRC - ODMS_FETCH_METADATA_SRC - ODMS_FETCH_METADATA_TGT - ODMS_VALIDATE - ODMS_PREPARE - ODMS_INITIALIZE_REPLICATION_INFRASTRUCTURE - ODMS_INITIAL_LOAD_EXPORT - ODMS_DATA_UPLOAD - ODMS_METADATA_TRANSFER - ODMS_INITIAL_LOAD_EXPORT_DATA_UPLOAD - ODMS_INITIAL_LOAD_IMPORT - ODMS_POST_INITIAL_LOAD - ODMS_PREPARE_REPLICATION_TARGET - ODMS_MONITOR_REPLICATION_LAG - ODMS_SWITCHOVER - ODMS_CLEANUP type: string x-obmcs-top-level-enum: '#/definitions/OdmsJobPhases' required: - id - databaseCombination - displayName - compartmentId - type - sourceDatabaseConnectionId - targetDatabaseConnectionId - timeCreated - lifecycleState type: object AssessorCheckNameValue: description: User Defined Check Name-Value Property properties: name: description: The property name. maxLength: 100 minLength: 0 type: string value: description: The property value. maxLength: 500 minLength: 0 type: string required: - name - value type: object UpdateAdvisorReportCheckObjectsDetails: description: 'Optional additional properties for update advisor report check. Default kind is LIST_OBJECTS ' discriminator: propertyName: kind properties: kind: default: LIST_OBJECTS description: 'Type of update advisor report check. Default kind is LIST_OBJECTS ' enum: - ALL_OBJECTS - LIST_OBJECTS type: string required: - kind type: object x-example: "{\n \"kind\": \"LIST_OBJECTS\",\n}\n" WorkRequest: description: 'An asynchronous work request. ' properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request. ' maxLength: 255 minLength: 1 type: string id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. ' maxLength: 255 minLength: 1 type: string operationType: description: 'Type of the work request ' enum: - CREATE_MIGRATION - CLONE_MIGRATION - DELETE_MIGRATION - UPDATE_MIGRATION - START_MIGRATION - VALIDATE_MIGRATION - CREATE_CONNECTION - DELETE_CONNECTION - UPDATE_CONNECTION - CREATE_ASSESSMENT - DELETE_ASSESSMENT - UPDATE_ASSESSMENT - RUN_ASSESSOR_ACTION - RUN_MIGRATE_TABLE_ASSESSOR - RUN_COMPATIBILITY_ASSESSOR - RUN_VIABILITY_ASSESSOR - CONFIGURE_MIGRATION_ASSESSOR - CREATE_MIGRATION_ASSESSOR - PREPARE_SOURCE_ASSESSOR - PREPARE_TARGET_ASSESSOR - CONFIRM_VIABILITY_ASSESSOR type: string x-obmcs-top-level-enum: '#/definitions/OperationTypes' percentComplete: description: 'The percentage complete of the operation tracked by this work request. ' format: float type: number resources: description: 'The resources that are affected by this work request. ' items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: 'Status of current work request. ' enum: - ACCEPTED - IN_PROGRESS - WAITING - FAILED - SUCCEEDED - CANCELING - CANCELED type: string x-obmcs-top-level-enum: '#/definitions/OperationStatus' timeAccepted: description: 'The date and time the work request was created, in the format defined by RFC3339. ' format: date-time type: string timeFinished: description: 'The date and time the work request reached a terminal state, either `FAILED` or `SUCCEEDED`. Format is defined by RFC3339. ' format: date-time type: string timeStarted: description: 'The date and time the work request transitioned from `ACCEPTED` to `IN_PROGRESS`, in the format defined by RFC3339. ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted x-example: "Example response: Work request that tracks the launch instance operation\n{\n \"operationType\": \"LaunchInstance\",\n \"status\": \"SUCCEEDED\",\n \"id\": \"ocid1.coreservicesworkrequest.oc1.phx.exampleunique_ID\",\n \"compartmentId\": \"ocid1.tenancy.oc1..exampleunique_ID\",\n \"resources\": [\n {\n \"actionType\": \"CREATED\",\n \"entityType\": \"instance\",\n \"identifier\": \"ocid1.instance.oc1.phx.exampleunique_ID\",\n \"entityUri\": \"/20160918/instances/ocid1.instance.oc1.phx.exampleunique_ID\"\n }\n ],\n \"percentComplete\": 100.0,\n \"timeAccepted\": \"2019-05-06T23:02:52.319Z\",\n \"timeStarted\": \"2019-05-06T23:02:57.592Z\",\n \"timeFinished\": \"2019-05-06T23:03:59.744Z\"\n}\n" MigrationJobProgressResource: description: 'Progress details of a Migration Job. ' properties: currentPhase: description: 'Current phase of the job. ' enum: - ODMS_VALIDATE_TGT - ODMS_VALIDATE_SRC - ODMS_VALIDATE_PREMIGRATION_ADVISOR - ODMS_VALIDATE_GG_HUB - ODMS_VALIDATE_DATAPUMP_SETTINGS - ODMS_VALIDATE_DATAPUMP_SETTINGS_SRC - ODMS_VALIDATE_DATAPUMP_SETTINGS_TGT - ODMS_VALIDATE_DATAPUMP_SRC - ODMS_VALIDATE_DATAPUMP_ESTIMATE_SRC - ODMS_FETCH_METADATA_SRC - ODMS_FETCH_METADATA_TGT - ODMS_VALIDATE - ODMS_PREPARE - ODMS_INITIALIZE_REPLICATION_INFRASTRUCTURE - ODMS_INITIAL_LOAD_EXPORT - ODMS_DATA_UPLOAD - ODMS_METADATA_TRANSFER - ODMS_INITIAL_LOAD_EXPORT_DATA_UPLOAD - ODMS_INITIAL_LOAD_IMPORT - ODMS_POST_INITIAL_LOAD - ODMS_PREPARE_REPLICATION_TARGET - ODMS_MONITOR_REPLICATION_LAG - ODMS_SWITCHOVER - ODMS_CLEANUP type: string x-obmcs-top-level-enum: '#/definitions/OdmsJobPhases' currentStatus: description: 'Current status of the job. ' enum: - PENDING - STARTED - COMPLETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/JobPhaseStatus' phases: description: 'List of phase status for the job. ' items: $ref: '#/components/schemas/PhaseStatus' type: array required: - currentStatus - currentPhase - phases type: object x-example: "{\n \"currentStatus\": \"STARTED\",\n \"currentPhase\": \"ZDM_VALIDATE_TGT\",\n \"phases\": [\n {\n \"name\": \"ZDM_VALIDATE_TGT\",\n \"status\": \"STARTED\",\n \"durationInMs\": 600,\n \"progress\": 20\n },\n {\n \"name\": \"ZDM_VALIDATE_SRC\",\n \"status\": \"PENDING\",\n \"durationInMs\": 0,\n \"progress\": 0\n },\n {\n \"name\": \"ZDM_VALIDATE_DATAPUMP_SETTINGS\",\n \"status\": \"PENDING\",\n \"durationInMs\": 0,\n \"progress\": 0\n\n },\n {\n \"name\": \"ZDM_PREPARE_DATAPUMP\",\n \"status\": \"PENDING\",\n \"durationInMs\": 0,\n \"progress\": 0\n },\n {\n \"name\": \"ZDM_DATAPUMP_EXPORT\",\n \"status\": \"PENDING\",\n \"durationInMs\": 0,\n \"progress\": 0\n },\n {\n \"name\": \"ZDM_UPLOAD_DATAPUMP_DUMP_FILES\",\n \"status\": \"PENDING\",\n \"durationInMs\": 0,\n \"progress\": 0\n },\n {\n \"name\": \"ZDM_DATAPUMP_IMPORT\",\n \"status\": \"PENDING\",\n \"durationInMs\": 0,\n \"progress\": 0\n },\n {\n \"name\": \"ZDM_POST_DATAPUMP\",\n \"status\": \"PENDING\",\n \"durationInMs\": 0,\n \"progress\": 0\n },\n {\n \"name\": \"ZDM_POST_ACTIONS\",\n \"status\": \"PENDING\",\n \"durationInMs\": 0,\n \"progress\": 0\n }\n ]\n}\n" AssessorCheckGroup: description: Assessor Check Group properties: description: description: "A user-friendly description. Does not have to be unique, and it's changeable. \nAvoid entering confidential information.\n" maxLength: 400 minLength: 0 type: string x-default-description: 'null' displayName: description: "A user-friendly name. Does not have to be unique, and it's changeable. \nAvoid entering confidential information.\n" maxLength: 255 minLength: 1 type: string isExpanded: default: false description: True if the group is expanded, false otherwise. type: boolean name: description: Assessor Check Group name, e.g. ADVANCED. maxLength: 255 minLength: 0 type: string required: - name - displayName type: object JobCollection: description: 'Results of a Job search. Contains JobSummary items. ' properties: items: description: 'Items in collection. ' items: $ref: '#/components/schemas/JobSummary' type: array required: - items type: object x-example: "{\n \"items\": [\n {\n \"id\": \"ocid1.odms-job.oc1..exampleunique_ID\",\n \"migrationId\": \"ocid1.odms-migration.oc1..exampleunique_ID\",\n \"displayName\": \"jobName\",\n \"type\": \"MIGRATION\",\n \"timeCreated\": \"2020-08-03T16:46:26.550Z\",\n \"timeUpdated\": \"2020-08-03T16:46:26.550Z\",\n \"progress\": {\n \"currentStatus\": \"STARTED\",\n \"currentPhase\": \"ZDM_VALIDATE_TGT\",\n \"jobProgreess\": 15\n },\n \"lifecycleState\": \"IN_PROGRESS\",\n \"lifecycleDetails\": \"Target Database checks in progress.\",\n \"freeformTags\": {\"Department\": \"Finance\"},\n \"definedTags\":\n {\n \"MyFirstNamespace\":\n {\n \"CostCenter\": \"SmartAlec\",\n \"Project\": \"42\",\n \"CreatedBy\": \"SmartAlec\",\n \"CreatedDate\": \"9/21/2017T14:00\"\n }\n }\n }\n ]\n}\n" PerformAssessorActionDetails: description: Array of name-value pairs for assessor action. properties: items: description: Array of name-value details for assessor action. items: $ref: '#/components/schemas/AssessorCheckNameValue' type: array required: - items type: object WorkRequestCollection: description: 'Results of a Work Request search. Contains WorkRequestSummary items. ' properties: items: description: 'Items in collection. ' items: $ref: '#/components/schemas/WorkRequestSummary' type: array required: - items type: object UserDefinedProperties: description: User defined properties properties: description: description: "A user-friendly description. Does not have to be unique, and it's changeable. \nAvoid entering confidential information.\n" maxLength: 400 minLength: 0 type: string x-default-description: 'null' displayName: description: "A user-friendly name. Does not have to be unique, and it's changeable. \nAvoid entering confidential information.\n" maxLength: 255 minLength: 1 type: string helpLinkText: description: The Help link text. maxLength: 255 minLength: 0 type: string helpLinkUrl: description: The Help URL. maxLength: 255 minLength: 0 type: string properties: description: Array of user defined properties. items: $ref: '#/components/schemas/UserDefinedProperty' maxLength: 255 minLength: 0 type: array required: - displayName type: object AssessmentObjectTypeSummary: description: Assessment Object Type properties: name: description: Object type name type: string required: - name type: object CollectTracesDetails: description: 'Details for collecting DB traces and alert logs ' properties: bucketName: description: 'Name of the bucket containing the file. ' maxLength: 255 minLength: 1 type: string namespace: description: 'Object Storage namespace. ' maxLength: 255 minLength: 1 type: string objectNamePrefix: description: 'Object name prefix. ' maxLength: 255 minLength: 1 type: string required: - bucketName - namespace - objectNamePrefix type: object CreateParameterFileVersionDetails: description: 'Details about a specific ParameterFileVersion ' properties: content: description: The content in base64 encoded character string containing the value of the parameter file type: string description: description: Describes the current parameter file version type: string kind: description: Indicator of Parameter File 'kind' (for an EXTRACT or a REPLICAT) enum: - EXTRACT - REPLICAT type: string x-obmcs-top-level-enum: '#/definitions/JobParameterFileVersionKind' name: description: Customizable name for the paramenter file version. type: string required: - kind - content type: object x-example: "{\n \"kind\": \"EXTRACT\",\n \"content\": \"RVhUUkFDVCBmaW5hbmNlXG5VU0VSSURBTElBUyB0aWdlcjFcbkxPR0FMTFNVUENPTFNcbk5DUllQVFRSQUlMIEFFUzE5MlxuRVhUVFJBSUwgL2dncy9kaXJkYXQvbHRcblNFUVVFTkNFIGhyLmVtcGxveWVlc19zZXE7XG5UQUJMRSBoci4q\"\n}\n" WorkRequestResource: description: 'A resource that is created or operated on by an asynchronous operation that is tracked by a work request. ' properties: actionType: description: 'The way in which this resource was affected by the operation that spawned the work request. ' enum: - CREATED - UPDATED - DELETED - RELATED - IN_PROGRESS type: string entityType: description: 'The resource type the work request affects. ' type: string entityUri: description: 'The URI path that you can use for a GET request to access the resource metadata. ' type: string identifier: description: 'An [OCID](/iaas/Content/General/Concepts/identifiers.htm) or other unique identifier for the resource. ' type: string required: - actionType - entityType - identifier MigrationSummary: description: Migration resource discriminator: propertyName: databaseCombination properties: assessmentId: description: The OCID of the resource being referenced. maxLength: 255 minLength: 1 type: string compartmentId: description: The OCID of the resource being referenced. maxLength: 255 minLength: 1 type: string databaseCombination: description: 'The combination of source and target databases participating in a migration. Example: ORACLE means the migration is meant for migrating Oracle source and target databases. ' enum: - MYSQL - ORACLE type: string x-obmcs-top-level-enum: '#/definitions/DatabaseCombination' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: "A user-friendly name. Does not have to be unique, and it's changeable. \nAvoid entering confidential information.\n" maxLength: 255 minLength: 1 type: string executingJobId: description: The OCID of the resource being referenced. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. \nFor more information, see Resource Tags. Example: {\"Department\": \"Finance\"}\n" type: object id: description: The OCID of the resource being referenced. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Additional status related to the execution and current state of the Migration. enum: - READY - ABORTING - VALIDATING - VALIDATED - ASSESSED - WAITING - MIGRATING - DONE type: string x-obmcs-top-level-enum: '#/definitions/MigrationStatus' lifecycleState: description: The current state of the Migration resource. enum: - CREATING - UPDATING - ACTIVE - IN_PROGRESS - ACCEPTED - SUCCEEDED - CANCELED - WAITING - NEEDS_ATTENTION - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/MigrationLifecycleStates' sourceDatabaseConnectionId: description: The OCID of the resource being referenced. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object targetDatabaseConnectionId: description: The OCID of the resource being referenced. maxLength: 255 minLength: 1 type: string timeCreated: description: 'An RFC3339 formatted datetime string such as `2016-08-25T21:10:29.600Z`. ' format: date-time type: string timeLastMigration: description: 'An RFC3339 formatted datetime string such as `2016-08-25T21:10:29.600Z`. ' format: date-time type: string timeUpdated: description: 'An RFC3339 formatted datetime string such as `2016-08-25T21:10:29.600Z`. ' format: date-time type: string type: description: 'The type of the migration to be performed. Example: ONLINE if no downtime is preferred for a migration. This method uses Oracle GoldenGate for replication. ' enum: - ONLINE - OFFLINE type: string x-obmcs-top-level-enum: '#/definitions/MigrationTypes' required: - id - databaseCombination - displayName - compartmentId - type - sourceDatabaseConnectionId - targetDatabaseConnectionId - timeCreated - lifecycleState type: object x-example: "{\n \"id\": \"ocid1.odmsmigration.oc1..exampleunique_ID\",\n \"compartmentId\": \"ocid1.compartment.oc1..exampleunique_ID\",\n \"displayName\": \"migrationName\",\n \"type\": \"ONLINE\",\n \"sourceDatabaseConnectionId\": \"ocid1.odmsconnection.oc1..exampleunique_ID\",\n \"targetDatabaseConnectionId\": \"ocid1.odmsconnection.oc1..exampleunique_ID\",\n \"timeCreated\": \"2020-08-03T16:46:26.550Z\",\n \"timeUpdated\": \"2020-08-03T16:46:26.550Z\",\n \"lifecycleState\": \"ACTIVE\",\n \"lifecycleDetails\": \"READY\"\n}\n" MigrationParameterSummaryCollection: description: List of Migration Parameter Summary objects. properties: items: description: List of Migration Parameters. items: $ref: '#/components/schemas/MigrationParameterSummary' type: array required: - items type: object x-example: "{\n \"items\": [\n {\n \"name\": \"DATAPUMPSETTINGS_DATAPUMPPARAMETERS_RETAININDEX\",\n \"dataType\": \"BOOLEAN\",\n \"databaseCombination\": \"ORACLE\",\n \"displayName\": \"Retain Index\",\n \"categoryName\": \"DATAPUMPSETTINGS\",\n \"categoryDisplayName\": \"Data Pump Settings\",\n \"docUrlLink\": \"https://docs.oracle.com/en/database/oracle/zero-downtime-migration/21.1/zdmug/zero-downtime-migration-logical-migration-response-file-parameters-reference.html#GUID-5D3AA59A-7AAD-4E7F-8EC1-8570DFD970A7\",\n \"description\": \"(DATAPUMPSETTINGS_DATAPUMPPARAMETERS_RETAININDEX) - Specifies whether to retain the index\",\n \"migrationType\": \"OFFLINE\",\n \"defaultValue\": \"false\",\n \"minValue\": 0,\n \"maxValue\": 0,\n \"hintText\": null\n }\n ]\n}\n" CloneAssessmentDetails: description: Customizable details when performing cloning of an Assessment. discriminator: propertyName: databaseCombination properties: compartmentId: description: The OCID of the resource being referenced. maxLength: 255 minLength: 1 type: string databaseCombination: description: 'The combination of source and target databases participating in a migration. Example: ORACLE means the migration is meant for migrating Oracle source and target databases. ' enum: - MYSQL - ORACLE type: string x-obmcs-top-level-enum: '#/definitions/DatabaseCombination' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: "A user-friendly name. Does not have to be unique, and it's changeable. \nAvoid entering confidential information.\n" maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. \nFor more information, see Resource Tags. Example: {\"Department\": \"Finance\"}\n" type: object sourceDatabaseConnection: $ref: '#/components/schemas/SourceAssessmentConnection' targetDatabaseConnection: $ref: '#/components/schemas/TargetAssessmentConnection' required: - databaseCombination - sourceDatabaseConnection - targetDatabaseConnection type: object AssessmentObjectTypeSummaryCollection: description: Results of an Assessment Object Type listing. Contains AssessmentObjectTypeSummary items. properties: items: description: Items in collection. items: $ref: '#/components/schemas/AssessmentObjectTypeSummary' type: array required: - items type: object AssessorAction: description: Assessor Action properties: description: description: "A user-friendly description. Does not have to be unique, and it's changeable. \nAvoid entering confidential information.\n" maxLength: 400 minLength: 0 type: string x-default-description: 'null' displayName: description: "A user-friendly name. Does not have to be unique, and it's changeable. \nAvoid entering confidential information.\n" maxLength: 255 minLength: 1 type: string isDisabled: description: Defines if the action is enabled or disabled. type: boolean name: description: The Assessor Action Name. enum: - RUN - CONFIGURE - CONFIGURE_MIGRATION - CREATE_MIGRATION - UPDATE_MIGRATION - RECHECK - RUN_SQL - DOWNLOAD_SQL - DOWNLOAD_LOG - CONFIRM - MANAGE type: string x-obmcs-top-level-enum: '#/definitions/AssessorActionNames' resourceId: description: The OCID of the resource being referenced. maxLength: 255 minLength: 1 type: string title: description: The Assessor Action Title. maxLength: 255 minLength: 1 type: string userDefinedProperties: $ref: '#/components/schemas/UserDefinedProperties' required: - name - displayName - title - isDisabled type: object AssessorSummary: description: Assessor Summary properties: actions: description: Assessor actions. items: $ref: '#/components/schemas/AssessorAction' maxLength: 100 minLength: 0 type: array assessmentId: description: The OCID of the resource being referenced. maxLength: 255 minLength: 1 type: string assessorGroup: $ref: '#/components/schemas/AssessorGroup' assessorResult: description: The Assessor Result text. maxLength: 500 minLength: 0 type: string checksSummary: description: The Summary of all Checks. maxLength: 255 minLength: 1 type: string description: description: "A user-friendly description. Does not have to be unique, and it's changeable. \nAvoid entering confidential information.\n" maxLength: 400 minLength: 0 type: string x-default-description: 'null' displayName: description: "A user-friendly name. Does not have to be unique, and it's changeable. \nAvoid entering confidential information.\n" maxLength: 255 minLength: 1 type: string doesScriptRequireRestart: default: false description: True if DB restart required after running the script, false otherwise. type: boolean hasScript: default: false description: True if script is available either from 'script' property of through download, false otherwise. type: boolean helpLinkText: description: The Help link text. maxLength: 255 minLength: 0 type: string helpLinkUrl: description: The Help URL. maxLength: 255 minLength: 0 type: string lifecycleState: description: The current state of the Assessor. enum: - ACCEPTED - IN_PROGRESS - SUCCEEDED - NEEDS_ATTENTION - FAILED type: string x-obmcs-top-level-enum: '#/definitions/AssessorLifecycleStates' name: description: The Assessor Name. maxLength: 255 minLength: 1 type: string script: description: 'The generated SQL script. Can be empty if the script exceeds maxLength. In this case the property ''hasScript'' indicates that the script is available for download. ' maxLength: 20000 minLength: 0 type: string required: - assessmentId - name - displayName - description - lifecycleState - actions - helpLinkUrl - helpLinkText type: object AssessorCheck: allOf: - $ref: '#/components/schemas/AssessorCheckSummary' description: Assessor Check type: object ChangeMigrationCompartmentDetails: description: Details pertaining to change of a migration's compartment. properties: compartmentId: description: The OCID of the resource being referenced. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object x-example: "Example of Change Compartment Operation request body:\n{\n \"compartmentId\": \"ocid1.tenancy.oc1..exampleunique_ID\",\n}\n" AssessmentSummary: description: Assessment Summary resource discriminator: propertyName: databaseCombination properties: compartmentId: description: The OCID of the resource being referenced. maxLength: 255 minLength: 1 type: string databaseCombination: description: 'The combination of source and target databases participating in a migration. Example: ORACLE means the migration is meant for migrating Oracle source and target databases. ' enum: - MYSQL - ORACLE type: string x-obmcs-top-level-enum: '#/definitions/DatabaseCombination' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: "A user-friendly name. Does not have to be unique, and it's changeable. \nAvoid entering confidential information.\n" maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. \nFor more information, see Resource Tags. Example: {\"Department\": \"Finance\"}\n" type: object id: description: The OCID of the resource being referenced. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the Assessment resource. enum: - CREATING - UPDATING - ACTIVE - SUCCEEDED - IN_PROGRESS - NEEDS_ATTENTION - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/AssessmentLifecycleStates' migrationId: description: The OCID of the resource being referenced. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'An RFC3339 formatted datetime string such as `2016-08-25T21:10:29.600Z`. ' format: date-time type: string timeUpdated: description: 'An RFC3339 formatted datetime string such as `2016-08-25T21:10:29.600Z`. ' format: date-time type: string required: - id - databaseCombination - displayName - compartmentId - timeCreated - lifecycleState type: object WorkRequestError: description: 'An error encountered while executing an operation that is tracked by a work request. ' properties: code: description: 'A machine-usable code for the error that occured. Error codes are listed on [API Errors](https://docs.cloud.oracle.com/Content/API/References/apierrors.htm) ' type: string message: description: 'A human-readable error string. ' type: string timestamp: description: 'The time the error occured. An RFC3339 formatted datetime string. ' format: date-time type: string required: - code - message - timestamp x-example: "{\n \"code\" : \"InternalError\",\n \"message\" : \"Launch instance failed, Retrying failed to complete successfully after 5 attempts.\",\n \"timestamp\" : \"2019-05-07T01:04:43.543Z\"\n}\n" DatabaseConnectionTypeCollection: description: Collection of Connection type objects. properties: items: description: Items in collection. items: $ref: '#/components/schemas/DatabaseConnectionTypeSummary' maxLength: 255 minLength: 0 type: array required: - items type: object DownloadSqlDetails: description: The response object of the Download SQL action properties: downloadUrl: description: The URL of the SQL script to download. maxLength: 500 minLength: 0 type: string required: - downloadUrl type: object UserDefinedProperty: description: User Defined Property properties: defaultValue: description: The default value of the property. maxLength: 255 minLength: 0 type: string description: description: "A user-friendly description. Does not have to be unique, and it's changeable. \nAvoid entering confidential information.\n" maxLength: 400 minLength: 0 type: string x-default-description: 'null' displayName: description: "A user-friendly name. Does not have to be unique, and it's changeable. \nAvoid entering confidential information.\n" maxLength: 255 minLength: 1 type: string isRequired: description: True if the property is required, false otherwise type: boolean maxLength: default: 100 description: Maximum length of the text type: integer minLength: default: 0 description: Minimum length of the text type: integer name: description: The property name. maxLength: 100 minLength: 0 type: string options: description: User defined property options. items: $ref: '#/components/schemas/UserDefinedPropertyOption' maxLength: 100 minLength: 0 type: array type: description: The type of the user defined property. enum: - TEXT - PASSWORD - RADIO type: string value: description: The value of the property. maxLength: 255 minLength: 0 type: string required: - name - displayName - type type: object OdmsPhaseActions: description: 'Possible ODMS Job Phase actions. ' enum: - WAIT type: string AssessorSummaryCollection: description: Collection of assessor summaries. properties: items: description: Items in collection. items: $ref: '#/components/schemas/AssessorSummary' type: array required: - items type: object DatabaseTechnologyType: description: Technology type e.g. OCI_AUTONOMOUS_DATABASE, array of corresponding sub-types e.g. ADW_SHARED and versions. properties: databaseVersions: description: Array of database versions items: description: The database version maxLength: 100 minLength: 1 type: string maxLength: 100 minLength: 0 type: array technologySubTypes: description: Array of technology sub-types e.g. ADW_SHARED. items: $ref: '#/components/schemas/DatabaseTechnologySubType' maxLength: 255 minLength: 0 type: array technologyType: description: The technology type. enum: - OCI_AUTONOMOUS_DATABASE - OCI_MYSQL - ORACLE_DATABASE - ORACLE_EXADATA - AMAZON_RDS_ORACLE - AMAZON_AURORA_MYSQL - AMAZON_RDS_MYSQL - AZURE_MYSQL - GOOGLE_CLOUD_SQL_MYSQL - MYSQL_SERVER type: string x-obmcs-top-level-enum: '#/definitions/TechnologyType' required: - technologyType type: object ConnectionCollection: description: Array of connection summary objects. properties: items: description: An array of Connection summaries. items: $ref: '#/components/schemas/ConnectionSummary' type: array required: - items type: object UserDefinedPropertyOption: description: User defined property option properties: description: description: "A user-friendly description. Does not have to be unique, and it's changeable. \nAvoid entering confidential information.\n" maxLength: 400 minLength: 0 type: string x-default-description: 'null' displayName: description: "A user-friendly name. Does not have to be unique, and it's changeable. \nAvoid entering confidential information.\n" maxLength: 255 minLength: 1 type: string value: description: The option value. maxLength: 255 minLength: 0 type: string required: - displayName - value type: object AdvisorReportCheckColumn: description: 'Head of objects table. ' properties: displayName: description: 'Display name of column. ' type: string key: description: 'Id of column. ' type: string required: - key - displayName type: object x-example: "{\n \"key\": \"TABLE_NAME\",\n \"displayName\": \"Table\",\n}\n" ConnectionSummary: description: Represents the parameters common for all connections in list operation. discriminator: propertyName: connectionType properties: compartmentId: description: The OCID of the compartment. maxLength: 255 minLength: 1 type: string connectionType: description: Defines the type of connection. For example, ORACLE. enum: - MYSQL - ORACLE type: string x-obmcs-top-level-enum: '#/definitions/ConnectionType' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: "A user-friendly description. Does not have to be unique, and it's changeable. \nAvoid entering confidential information.\n" maxLength: 400 minLength: 0 type: string x-default-description: 'null' displayName: description: "A user-friendly name. Does not have to be unique, and it's changeable. \nAvoid entering confidential information.\n" maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. \nFor more information, see Resource Tags. Example: {\"Department\": \"Finance\"}\n" type: object id: description: The OCID of the connection being referenced. maxLength: 255 minLength: 1 type: string ingressIps: description: List of ingress IP addresses from where to connect to this connection's privateIp. items: $ref: '#/components/schemas/IngressIpDetails' type: array keyId: description: The OCID of the key used in cryptographic operations. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: 'A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. ' type: string lifecycleState: description: Lifecycle state for connection. type: string x-obmcs-enumref: '#/definitions/Connection/lifecycleState' nsgIds: description: 'An array of Network Security Group OCIDs used to define network access for Connections. ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array subnetId: description: OCI resource ID. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The time when this resource was created. An RFC3339 formatted datetime string such as `2016-08-25T21:10:29.600Z`. ' format: date-time type: string timeUpdated: description: 'The time when this resource was updated. An RFC3339 formatted datetime string such as `2016-08-25T21:10:29.600Z`. ' format: date-time type: string vaultId: description: OCI resource ID. maxLength: 255 minLength: 1 type: string required: - connectionType - id - displayName - compartmentId - lifecycleState - timeCreated - timeUpdated type: object Job: description: 'Results of a Database Connection search. Contains DatabaseConnectionSummary items. ' properties: collectTracesData: $ref: '#/components/schemas/CollectTracesData' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: 'Name of the job. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. \nFor more information, see Resource Tags. Example: {\"Department\": \"Finance\"}\n" type: object id: description: 'The OCID of the Migration Job. ' maxLength: 255 minLength: 1 type: string lifecycleDetails: description: 'A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. ' type: string lifecycleState: description: 'The current state of the migration job. ' enum: - ACCEPTED - IN_PROGRESS - UNKNOWN - TERMINATED - FAILED - SUCCEEDED - WAITING - CANCELING - CANCELED type: string x-obmcs-top-level-enum: '#/definitions/JobLifecycleStates' migrationId: description: 'The OCID of the Migration that this job belongs to. ' maxLength: 255 minLength: 1 type: string parameterFileVersions: description: 'A list of parameter file versions that can be viewed or edited for the current job. ' items: $ref: '#/components/schemas/ParameterFileVersionSummary' maxItems: 8 minItems: 0 type: array progress: $ref: '#/components/schemas/MigrationJobProgressResource' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'The time the Migration Job was created. An RFC3339 formatted datetime string ' format: date-time type: string timeUpdated: description: 'The time the Migration Job was last updated. An RFC3339 formatted datetime string ' format: date-time type: string type: description: 'The job type. ' enum: - EVALUATION - MIGRATION type: string x-obmcs-top-level-enum: '#/definitions/JobTypes' unsupportedObjects: description: 'Database objects not supported. ' items: $ref: '#/components/schemas/UnsupportedDatabaseObject' type: array required: - id - displayName - migrationId - type - timeCreated - lifecycleState type: object x-example: "{\n \"id\": \"ocid1.odms-job.oc1..exampleunique_ID\",\n \"migrationId\": \"ocid1.odms-migration.oc1..exampleunique_ID\",\n \"displayName\": \"jobName\",\n \"type\": \"MIGRATION\",\n \"timeCreated\": \"2020-08-03T16:46:26.550Z\",\n \"timeUpdated\": \"2020-08-03T16:46:26.550Z\",\n \"progress\": {\n \"currentStatus\": \"STARTED\",\n \"currentPhase\": \"ZDM_VALIDATE_TGT\",\n \"phases\": [\n {\n \"name\": \"ZDM_VALIDATE_TGT\",\n \"status\": \"STARTED\",\n \"durationInMs\": 600\n\n },\n {\n \"name\": \"ZDM_VALIDATE_SRC\",\n \"status\": \"PENDING\",\n \"durationInMs\": 0\n\n },\n {\n \"name\": \"ZDM_VALIDATE_DATAPUMP_SETTINGS\",\n \"status\": \"PENDING\",\n \"durationInMs\": 0\n\n },\n {\n \"name\": \"ZDM_PREPARE_DATAPUMP\",\n \"status\": \"PENDING\",\n \"durationInMs\": 0\n\n },\n {\n \"name\": \"ZDM_DATAPUMP_EXPORT\",\n \"status\": \"PENDING\",\n \"durationInMs\": 0\n\n },\n {\n \"name\": \"ZDM_UPLOAD_DATAPUMP_DUMP_FILES\",\n \"status\": \"PENDING\",\n \"durationInMs\": 0\n\n },\n {\n \"name\": \"ZDM_DATAPUMP_IMPORT\",\n \"status\": \"PENDING\",\n \"durationInMs\": 0\n\n },\n {\n \"name\": \"ZDM_POST_DATAPUMP\",\n \"status\": \"PENDING\",\n \"durationInMs\": 0\n\n },\n {\n \"name\": \"ZDM_POST_ACTIONS\",\n \"status\": \"PENDING\",\n \"editableParameterFiles\": [\"REPLICAT\"],\n \"durationInMs\": 0\n\n }\n ]\n },\n \"unsupportedObjects\": [\n {\n \"type\": \"GOLDEN_GATE\",\n \"owner\": \"user\",\n \"objectName\": \"exampleObj\"\n }\n ],\n \"parameterFileVersions\":\n [\n {\n \"name\": \"EXTNOWL9_ORIGINAL\",\n \"kind\": \"EXTRACT\",\n \"timeCreated\": \"2019-05-07T00:00:03.374Z\"\n },\n {\n \"name\": \"EXTNOWL9_20190507005045\",\n \"kind\": \"EXTRACT\",\n \"timeCreated\": \"2019-05-07T00:50:45.874Z\"\n },\n {\n \"name\": \"EXTNOWL9_2019050711532\",\n \"kind\": \"EXTRACT\",\n \"timeCreated\": \"2019-05-07T01:15:32.004Z\"\n },\n {\n \"name\": \"R4FAY_ORIGINAL\",\n \"kind\": \"REPLICAT\",\n \"timeCreated\": \"2019-05-07T02:75:34.425Z\"\n }\n ],\n \"lifecycleState\": \"IN_PROGRESS\",\n \"lifecycleDetails\": \"Target Database checks in progress.\",\n \"freeformTags\": {\"Department\": \"Finance\"},\n \"definedTags\":\n {\n \"MyFirstNamespace\":\n {\n \"CostCenter\": \"SmartAlec\",\n \"Project\": \"42\",\n \"CreatedBy\": \"SmartAlec\",\n \"CreatedDate\": \"9/21/2017T14:00\"\n }\n }\n}\n" ObjectMetadata: description: 'Metadata of object. ' properties: objectNameColumn: description: 'The field that stores the name of the object. ' type: string objectTypeColumn: description: 'The field that stores the type of the object. ' type: string objectTypeFixed: description: 'The field that stores the fixed type of the object. ' type: string schemaOwnerColumn: description: 'The field that stores the owner of the object. ' type: string required: - schemaOwnerColumn - objectNameColumn type: object x-example: "{\n \"schemaOwnerColumn\": \"OWNER\",\n \"objectNameColumn\": \"TABLE_NAME\",\n \"objectTypeFixed\": \"TABLE\",\n \"objectTypeColumn\": \"\",\n}\n" AdvisorReport: description: 'Premigration Advisor report details. ' properties: numberOfFatal: description: 'Number of Fatal results in the advisor report. ' type: integer numberOfFatalBlockers: description: 'Number of Fatal Blocker results in the advisor report. ' type: integer numberOfInformationalResults: description: 'Number of Informational results in the advisor report. ' type: integer numberOfWarnings: description: 'Number of Warning results in the advisor report. ' type: integer reportLocationDetails: $ref: '#/components/schemas/AdvisorReportLocationDetails' result: description: 'Premigration Advisor result. ' enum: - FATAL - BLOCKER - WARNING - INFORMATIONAL - PASS type: string x-obmcs-top-level-enum: '#/definitions/AdvisorResults' required: - result - numberOfFatal - numberOfFatalBlockers - numberOfWarnings - numberOfInformationalResults type: object x-example: "{\n \"reportLocationDetails\": {\n objectStorageDetails {\n \"bucketName\": \"dataBucket\",\n \"namespace\": \"tenancyNamespace\",\n \"objectName\": \"advisor_report.out\",\n },\n \"locationInSource\" \"/path/in/source/to/advisor/report\"\n },\n \"result\": \"BLOCKER\",\n \"numberOfFatal\": integer,\n \"numberOfFatalBlockers\": integer,\n \"numberOfWarnings\": integer,\n \"numberOfInformationalResults\": integer\n}\n" AssessorCheckSummary: description: Assessor Check Summary properties: action: description: 'Fixing the issue. ' maxLength: 4000 minLength: 1 type: string assessorCheckGroup: $ref: '#/components/schemas/AssessorCheckGroup' assessorCheckState: description: The current state of the Assessor Check. enum: - PENDING_APPROVAL - PENDING_RESOLUTION - PENDING_VALIDATION - NOT_ACKNOWLEDGED - APPROVED - ACKNOWLEDGED - VALIDATED - PASSED - PENDING - STARTED - COMPLETED - FAILED - SKIPPED type: string x-obmcs-top-level-enum: '#/definitions/AssessorCheckStates' checkAction: $ref: '#/components/schemas/AssessorCheckAction' columns: description: 'Array of the column of the objects table. ' items: $ref: '#/components/schemas/AdvisorReportCheckColumn' maxLength: 1024 minLength: 1 type: array description: description: "A user-friendly description. Does not have to be unique, and it's changeable. \nAvoid entering confidential information.\n" maxLength: 400 minLength: 0 type: string x-default-description: 'null' displayName: description: "A user-friendly name. Does not have to be unique, and it's changeable. \nAvoid entering confidential information.\n" maxLength: 255 minLength: 1 type: string fixupScriptLocation: description: 'The path to the fixup script for this check. ' maxLength: 255 minLength: 1 type: string helpLinkText: description: The Help link text. maxLength: 255 minLength: 0 type: string helpLinkUrl: description: The Help URL. maxLength: 255 minLength: 0 type: string impact: description: 'Impact of the issue on data migration. ' maxLength: 4000 minLength: 1 type: string isExclusionAllowed: description: 'If false, objects cannot be excluded from migration. ' type: boolean issue: description: 'Description of the issue. ' maxLength: 4000 minLength: 1 type: string key: description: 'Pre-Migration сheck id. ' maxLength: 4000 minLength: 1 type: string logLocation: $ref: '#/components/schemas/LogLocationBucketDetails' metadata: $ref: '#/components/schemas/ObjectMetadata' name: description: The Name of the Check. maxLength: 255 minLength: 1 type: string objectCount: description: 'Number of database objects to migrate. ' type: integer objectsDisplayName: description: 'The objects display name. ' maxLength: 255 minLength: 1 type: string required: - name - displayName - assessorCheckGroup - assessorCheckState type: object LogLocationBucketDetails: description: 'Details to access log file in the specified Object Storage bucket, if any. ' properties: bucketName: description: 'Name of the bucket containing the log file. ' maxLength: 255 minLength: 1 type: string namespace: description: 'Object Storage namespace. ' maxLength: 255 minLength: 1 type: string objectName: description: 'Log object name. ' maxLength: 255 minLength: 1 type: string required: - bucketName - namespace - objectName type: object WorkRequestErrorCollection: description: 'Results of a Work Request search. Contains WorkRequestError items. ' properties: items: description: 'Items in collection. ' items: $ref: '#/components/schemas/WorkRequestError' type: array required: - items type: object AssessorCheckAction: description: Assessor Check Action properties: description: description: "A user-friendly description. Does not have to be unique, and it's changeable. \nAvoid entering confidential information.\n" maxLength: 400 minLength: 0 type: string x-default-description: 'null' displayName: description: "A user-friendly name. Does not have to be unique, and it's changeable. \nAvoid entering confidential information.\n" maxLength: 255 minLength: 1 type: string name: description: The Assessor Check Action Name. enum: - APPROVE - DISAPPROVE - ACKNOWLEDGE - UNACKNOWLEDGE type: string x-obmcs-top-level-enum: '#/definitions/AssessorCheckActionNames' userDefinedProperties: $ref: '#/components/schemas/UserDefinedProperties' required: - name - displayName type: object DatabaseTechnologySubType: description: Technology sub-type e.g. ADW_SHARED and database versions corresponding to the sub-type. properties: databaseVersions: description: Array of database versions items: description: The database version maxLength: 100 minLength: 1 type: string type: array technologySubType: description: Technology sub-type e.g. ADW_SHARED. type: string technologySubTypeDisplayName: description: "A user-friendly name. Does not have to be unique, and it's changeable. \nAvoid entering confidential information.\n" maxLength: 255 minLength: 1 type: string type: object MigrationObjectCollection: description: Common Migration Objects collection. discriminator: propertyName: databaseCombination properties: databaseCombination: description: 'The combination of source and target databases participating in a migration. Example: ORACLE means the migration is meant for migrating Oracle source and target databases. ' enum: - MYSQL - ORACLE type: string x-obmcs-top-level-enum: '#/definitions/DatabaseCombination' required: - databaseCombination type: object ChangeConnectionCompartmentDetails: description: 'Details for changing the compartment for a Connection. ' properties: compartmentId: description: The OCID of the compartment. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object Assessor: allOf: - $ref: '#/components/schemas/AssessorSummary' description: Assessor resource type: object AdvisorReportBucketDetails: description: 'Details to access Premigration Advisor report in the specified Object Storage bucket. ' properties: bucketName: description: 'Name of the bucket containing the Premigration Advisor report. ' maxLength: 255 minLength: 1 type: string namespace: description: 'Object Storage namespace. ' maxLength: 255 minLength: 1 type: string objectName: description: 'Premigration Advisor report object name. ' maxLength: 255 minLength: 1 type: string required: - bucketName - namespace - objectName type: object AdvisorReportLocationDetails: description: 'Details to access Premigration Advisor report. ' properties: locationInSource: description: 'File system path on the Source Database host where the Premigration Advisor report can be accessed. ' maxLength: 4096 minLength: 0 type: string objectStorageDetails: $ref: '#/components/schemas/AdvisorReportBucketDetails' type: object WorkRequestLogEntryCollection: description: 'Results of a Work Request search. Contains WorkRequestLogEntry items. ' properties: items: description: 'Items in collection. ' items: $ref: '#/components/schemas/WorkRequestLogEntry' type: array required: - items type: object parameters: MigrationLifecycleStateQueryParam: description: 'The lifecycle state of the Migration. ' in: query name: lifecycleState x-default-description: ACTIVE x-obmcs-top-level-enum: '#/definitions/MigrationLifecycleStates' schema: type: string enum: - CREATING - UPDATING - ACTIVE - IN_PROGRESS - ACCEPTED - SUCCEEDED - CANCELED - WAITING - NEEDS_ATTENTION - INACTIVE - DELETING - DELETED - FAILED ObjectTypeQueryParam: description: 'Excluded object type. ' in: query name: type x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 NameQueryParam: description: 'A filter to return only resources that match the entire name given. ' in: query name: name x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 JobLifecycleOperationQueryParam: description: 'The lifecycle state of the Migration Job. ' in: query name: lifecycleState x-default-description: IN_PROGRESS x-obmcs-top-level-enum: '#/definitions/JobLifecycleStates' schema: type: string enum: - ACCEPTED - IN_PROGRESS - UNKNOWN - TERMINATED - FAILED - SUCCEEDED - WAITING - CANCELING - CANCELED IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match required: false schema: type: string ParameterFileNamePathParam: description: 'A unique name associated with the current migration/job and extract/replicat name ' in: path name: parameterFileName required: true schema: type: string maxLength: 255 minLength: 1 MigrationIdPathParam: description: 'The OCID of the migration ' in: path name: migrationId required: true schema: type: string maxLength: 255 minLength: 1 WorkRequestLogSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timestamp is descending. ' in: query name: sortBy schema: type: string enum: - timestamp default: timestamp SortOrderQueryParam: description: 'The sort order to use, either ''asc'' or ''desc''. ' in: query name: sortOrder x-obmcs-top-level-enum: '#/definitions/SortOrders' schema: type: string enum: - ASC - DESC default: ASC ObjectOwnerQueryParam: description: 'Excluded object owner ' in: query name: owner x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 RequestIdHeader: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string pattern: '[A-Za-z0-9\-_\.]+' AssessorCheckNamePathParam: description: The Name of the assessor check in: path name: checkName required: true schema: type: string maxLength: 255 minLength: 1 ScripIdPathParam: description: The ID of the script to download. in: path name: scriptId required: true x-obmcs-top-level-enum: '#/definitions/ScriptIds' schema: type: string enum: - USER_CREATION_SQL_SCRIPT LifecycleStateQueryParam: description: 'The current state of the Database Migration Deployment. ' in: query name: lifecycleState x-default-description: ACTIVE x-obmcs-top-level-enum: '#/definitions/LifecycleStates' schema: type: string enum: - CREATING - UPDATING - ACTIVE - INACTIVE - DELETING - DELETED - FAILED SortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName default: timeCreated DatabaseCombinationQueryParam: description: 'A filter to return only resources that match a certain Database Combination. ' in: query name: databaseCombination required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/DatabaseCombination' schema: type: string enum: - MYSQL - ORACLE AssessmentLifecycleStateQueryParam: description: 'The lifecycle state of the Assessment. ' in: query name: lifecycleState x-default-description: ACTIVE x-obmcs-top-level-enum: '#/definitions/AssessmentLifecycleStates' schema: type: string enum: - CREATING - UPDATING - ACTIVE - SUCCEEDED - IN_PROGRESS - NEEDS_ATTENTION - DELETING - DELETED - FAILED WorkRequestStatusQueryParam: description: 'A filter to return only resources their lifecycleState matches the given OperationStatus. ' in: query name: status required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/OperationStatus' schema: type: string enum: - ACCEPTED - IN_PROGRESS - WAITING - FAILED - SUCCEEDED - CANCELING - CANCELED ConnectionTypeQueryParam: description: The array of connection types. in: query name: connectionType required: false x-default-description: 'null' x-example: ?connectionType=ORACLE style: form explode: true schema: type: array items: enum: - MYSQL - ORACLE type: string x-obmcs-top-level-enum: '#/definitions/ConnectionType' WorkRequestIdPathParam: description: 'The ID of the asynchronous request. ' in: path name: workRequestId required: true schema: type: string maxLength: 255 minLength: 1 TechnologySubTypeQueryParam: description: The database technology sub-type. in: query name: technologySubType required: false x-default-description: 'null' schema: type: string maxLength: 100 minLength: 1 TechnologyTypeQueryParam: description: The array of technology types. in: query name: technologyType required: false x-default-description: 'null' x-example: ?technologyType=ORACLE_EXADATA style: form explode: true schema: type: array items: enum: - OCI_AUTONOMOUS_DATABASE - OCI_MYSQL - ORACLE_DATABASE - ORACLE_EXADATA - AMAZON_RDS_ORACLE - AMAZON_AURORA_MYSQL - AMAZON_RDS_MYSQL - AZURE_MYSQL - GOOGLE_CLOUD_SQL_MYSQL - MYSQL_SERVER type: string x-obmcs-top-level-enum: '#/definitions/TechnologyType' AssessorNamePathParam: description: The name of the Assessor in: path name: assessorName required: true schema: type: string maxLength: 255 minLength: 1 AssessorCheckActionPathParam: description: The Accessor Check Action in: path name: assessorCheckAction required: true schema: type: string maxLength: 255 minLength: 1 DisplayNameQueryParam: description: 'A filter to return only resources that match the entire display name given. ' in: query name: displayName x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 ExcludeRuleQueryParam: description: 'Exclude object rule that matches the excluded object, if applicable. ' in: query name: sourceRule x-default-description: 'null' schema: type: string maxLength: 767 minLength: 1 MigrationTypeQueryParam: description: 'A filter to return only resources that match a certain Migration Type. ' in: query name: migrationType required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/MigrationTypes' schema: type: string enum: - ONLINE - OFFLINE PaginationTokenQueryParam: description: 'The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. ' in: query name: page schema: type: string default: 1 minLength: 1 ObjectNameContainsQueryParam: description: 'Excluded object name which contains provided value. ' in: query name: objectContains x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 JobIdPathParam: description: 'The OCID of the job ' in: path name: jobId required: true schema: type: string maxLength: 255 minLength: 1 AssessorActionPathParam: description: The Accessor Action in: path name: assessorAction required: true schema: type: string maxLength: 255 minLength: 1 SourceConnectionIdQueryParam: description: The OCID of the source connection. in: query name: sourceConnectionId required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 RetryTokenHeader: description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. ' in: header name: opc-retry-token required: false schema: type: string maxLength: 64 minLength: 1 ObjectReportSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for reasonCategory is ascending. If no value is specified reasonCategory is default. ' in: query name: sortBy schema: type: string enum: - type - reasonCategory default: reasonCategory WorkRequestSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. ' in: query name: sortBy schema: type: string enum: - timeAccepted default: timeAccepted SourceConnectionIdPathParam: description: The OCID of the source database connection. in: query name: sourceConnectionId required: false schema: type: string maxLength: 255 minLength: 1 MigrationObjectsConnectionTypeQueryParam: description: The connection type for migration objects. in: query name: connectionType required: true x-obmcs-top-level-enum: '#/definitions/ConnectionType' schema: type: string enum: - MYSQL - ORACLE AdvisorReportCheckIdPathParam: description: 'The ID of the advisor check ' in: path name: advisorReportCheckId required: true schema: type: string maxLength: 255 minLength: 1 AssessmentObjectsConnectionTypeQueryParam: description: The connection type for assessment objects. in: query name: connectionType required: true x-obmcs-top-level-enum: '#/definitions/ConnectionType' schema: type: string enum: - MYSQL - ORACLE CompartmentIdQueryParam: description: 'The ID of the compartment in which to list resources. ' in: query name: compartmentId required: true schema: type: string maxLength: 255 minLength: 1 PaginationLimitQueryParam: description: 'The maximum number of items to return. ' in: query name: limit schema: type: integer default: 10 maximum: 1000 minimum: 1 SortByObjectTypeParam: description: 'The field to sort by. Only one sort order may be provided. Default order for name is custom based on it''s usage frequency. If no value is specified name is default. ' in: query name: sortBy schema: type: string enum: - name default: name MigrationIdQueryParam: description: 'The ID of the migration in which to list resources. ' in: query name: migrationId required: true schema: type: string maxLength: 255 minLength: 1 ObjectOwnerContainsQueryParam: description: 'Excluded object owner which contains provided value. ' in: query name: ownerContains x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 ResourceIdQueryParam: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource. ' in: query name: resourceId required: false schema: type: string default: resourceId maxLength: 255 minLength: 1 ExcludeReasonCategoryQueryParam: description: 'Reason category for the excluded object ' in: query name: reasonCategory x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/ReasonKeywords' schema: type: string enum: - ORACLE_MAINTAINED - GG_UNSUPPORTED - USER_EXCLUDED - MANDATORY_EXCLUDED - USER_EXCLUDED_TYPE AssessorLifecycleStateQueryParam: description: The lifecycle state of the Assessor. in: query name: lifecycleState x-default-description: ACTIVE x-obmcs-top-level-enum: '#/definitions/AssessorLifecycleStates' schema: type: string enum: - ACCEPTED - IN_PROGRESS - SUCCEEDED - NEEDS_ATTENTION - FAILED AssessmentIdPathParam: description: 'The OCID of the Assessment ' in: path name: assessmentId required: true schema: type: string maxLength: 255 minLength: 1 JobIdNotEqualToQueryParam: description: 'The ID of the Job to exclude from the list of jobs. ' in: query name: jobIdNotEqualTo required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 LifecycleDetailsQueryParam: description: 'The lifecycle detailed status of the Migration. ' in: query name: lifecycleDetails x-default-description: READY x-obmcs-top-level-enum: '#/definitions/MigrationStatus' schema: type: string enum: - READY - ABORTING - VALIDATING - VALIDATED - ASSESSED - WAITING - MIGRATING - DONE ObjectNameQueryParam: description: 'Excluded object name ' in: query name: object x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 ConnectionIdPathParam: description: The OCID of the database connection. in: path name: connectionId required: true schema: type: string maxLength: 255 minLength: 1 responses: default: description: 'Unknown Error ' headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' type: string retry-after: description: 'A decimal number representing the number of seconds the client should wait before polling this endpoint again. ' format: float type: number x-properties: acceptableDowntime: description: Time allowed for the application downtime. enum: - LESS_THAN_10_MINUTES - LESS_THAN_1_HOUR - LESS_THAN_4_HOURS - LESS_THAN_8_HOURS - LESS_THAN_12_HOURS - LESS_THAN_1_DAY - LESS_THAN_2_DAYS - MORE_THAN_2_DAYS type: string x-obmcs-top-level-enum: '#/definitions/AcceptableDowntime' acceptableLag: description: 'ODMS will monitor GoldenGate end-to-end latency until the lag time is lower than the specified value in seconds. ' maximum: 30 type: integer additionalAttributes: description: An array of name-value pair attribute entries. items: $ref: '#/components/schemas/NameValuePair' type: array assessmentLifecycleState: description: The current state of the Assessment resource. enum: - CREATING - UPDATING - ACTIVE - SUCCEEDED - IN_PROGRESS - NEEDS_ATTENTION - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/AssessmentLifecycleStates' assessmentMigrationType: description: The migration type of the migration to be performed. enum: - ONLINE - ONLINE_STANDBY - OFFLINE type: string x-obmcs-top-level-enum: '#/definitions/AssessmentMigrationTypes' assessorActionName: description: The Assessor Action Name. enum: - RUN - CONFIGURE - CONFIGURE_MIGRATION - CREATE_MIGRATION - UPDATE_MIGRATION - RECHECK - RUN_SQL - DOWNLOAD_SQL - DOWNLOAD_LOG - CONFIRM - MANAGE type: string x-obmcs-top-level-enum: '#/definitions/AssessorActionNames' assessorCheckActionName: description: The Assessor Check Action Name. enum: - APPROVE - DISAPPROVE - ACKNOWLEDGE - UNACKNOWLEDGE type: string x-obmcs-top-level-enum: '#/definitions/AssessorCheckActionNames' assessorCheckAffectedObjects: description: The Assessor Check Affected Objects. maxLength: 255 minLength: 0 type: string assessorCheckState: description: The current state of the Assessor Check. enum: - PENDING_APPROVAL - PENDING_RESOLUTION - PENDING_VALIDATION - NOT_ACKNOWLEDGED - APPROVED - ACKNOWLEDGED - VALIDATED - PASSED - PENDING - STARTED - COMPLETED - FAILED - SKIPPED type: string x-obmcs-top-level-enum: '#/definitions/AssessorCheckStates' assessorLifecycleState: description: The current state of the Assessor. enum: - ACCEPTED - IN_PROGRESS - SUCCEEDED - NEEDS_ATTENTION - FAILED type: string x-obmcs-top-level-enum: '#/definitions/AssessorLifecycleStates' assessorName: description: The Assessor Name. maxLength: 255 minLength: 1 type: string assessorResult: description: The Assessor Result text. maxLength: 500 minLength: 0 type: string bucketName: description: 'Name of the bucket containing the file. ' maxLength: 255 minLength: 1 type: string bulkIncludeExcludeData: description: 'Specifies the database objects to be excluded from the migration in bulk. The definition accepts input in a CSV format, newline separated for each entry. More details can be found in the documentation. ' maxLength: 510000 type: string checkName: description: The Name of the Check. maxLength: 255 minLength: 1 type: string checksSummary: description: The Summary of all Checks. maxLength: 255 minLength: 1 type: string compartmentId: description: The OCID of the compartment. maxLength: 255 minLength: 1 type: string connectionId: description: The OCID of the connection being referenced. maxLength: 255 minLength: 1 type: string connectionString: description: 'Connect descriptor or Easy Connect Naming method used to connect to a database. ' maxLength: 2000 minLength: 1 type: string connectionType: description: Defines the type of connection. For example, ORACLE. enum: - MYSQL - ORACLE type: string x-obmcs-top-level-enum: '#/definitions/ConnectionType' connectionTypes: description: An array of connectionTypes. items: enum: - MYSQL - ORACLE type: string x-obmcs-top-level-enum: '#/definitions/ConnectionType' type: array creationType: description: The type of assessment creation. enum: - CREATE_ONLY - CREATE_AND_RUN_ASSESSORS type: string x-obmcs-top-level-enum: '#/definitions/CreationType' dataPumpTsBlockSizesInKb: default: SIZE_8K description: 'Size of Oracle database blocks in KB. ' enum: - SIZE_2K - SIZE_8K - SIZE_16K - SIZE_32K type: string x-obmcs-top-level-enum: '#/definitions/DataPumpTablespaceBlockSizesInKb' databaseCombination: description: 'The combination of source and target databases participating in a migration. Example: ORACLE means the migration is meant for migrating Oracle source and target databases. ' enum: - MYSQL - ORACLE type: string x-obmcs-top-level-enum: '#/definitions/DatabaseCombination' databaseDataSize: description: The size of a source database. enum: - LESS_THAN_1GB - GB_1_10 - GB_10_50 - GB_50_100 - GB_100_500 - GB_500_TB_1 - TB_1_3 - TB_3_10 - TB_10_50 - GREATER_THAN_50TB type: string x-obmcs-top-level-enum: '#/definitions/DatabaseDataSize' databaseId: description: 'The OCID of the database being referenced. ' maxLength: 255 minLength: 1 type: string databaseName: description: The name of the database being referenced. maxLength: 255 minLength: 1 type: string databaseVersion: description: The database version maxLength: 100 minLength: 1 type: string dateTime: description: 'An RFC3339 formatted datetime string such as `2016-08-25T21:10:29.600Z`. ' format: date-time type: string dbSystemId: description: 'The OCID of the database system being referenced. ' maxLength: 255 minLength: 1 type: string ddlExpectation: description: DDL expectation values. enum: - DDL_EXPECTED - DDL_NOT_EXPECTED type: string x-obmcs-top-level-enum: '#/definitions/DdlExpectation' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object deploymentName: description: Name of GoldenGate deployment maxLength: 255 minLength: 1 type: string description: description: "A user-friendly description. Does not have to be unique, and it's changeable. \nAvoid entering confidential information.\n" maxLength: 400 minLength: 0 type: string x-default-description: 'null' displayName: description: "A user-friendly name. Does not have to be unique, and it's changeable. \nAvoid entering confidential information.\n" maxLength: 255 minLength: 1 type: string excludeMySqlObjects: description: Database objects to exclude from migration, cannot be specified alongside 'includeObjects' items: $ref: '#/components/schemas/MySqlDatabaseObject' maxItems: 100 type: array excludeObjects: description: 'Database objects to exclude from migration, cannot be specified alongside ''includeObjects'' ' items: $ref: '#/components/schemas/OracleDatabaseObject' type: array excludeParameters: description: Exclude paratemers for Export and Import. items: $ref: '#/components/schemas/DataPumpExcludeParameters' type: array exportParallelismDegree: description: Maximum number of worker processes that can be used for a Data Pump Export job. maximum: 128 minimum: 2 type: integer freeformTags: additionalProperties: type: string description: "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. \nFor more information, see Resource Tags. Example: {\"Department\": \"Finance\"}\n" type: object groupDisplayName: description: 'Job Phase group display name e.g. ''Step 1: Migration'' ' maxLength: 100 minLength: 1 type: string helpLinkText: description: The Help link text. maxLength: 255 minLength: 0 type: string helpLinkUrl: description: The Help URL. maxLength: 255 minLength: 0 type: string host: description: The IP Address of the host. maxLength: 800 minLength: 1 type: string importParallelismDegree: description: 'Maximum number of worker processes that can be used for a Data Pump Import job. For an Autonomous Database, ODMS will automatically query its CPU core count and set this property. ' maximum: 128 minimum: 2 type: integer includeMySqlObjects: description: Database objects to include from migration, cannot be specified alongside 'excludeObjects' items: $ref: '#/components/schemas/MySqlDatabaseObject' maxItems: 100 type: array includeObjects: description: Database objects to include from migration, cannot be specified alongside 'excludeObjects' items: $ref: '#/components/schemas/OracleDatabaseObject' type: array ingressIp: description: A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet. maxLength: 46 minLength: 1 type: string ingressIps: description: List of ingress IP addresses from where to connect to this connection's privateIp. items: $ref: '#/components/schemas/IngressIpDetails' type: array isCluster: default: true description: Set to false to force Data Pump worker process to run on one instance. type: boolean keyId: description: The OCID of the key used in cryptographic operations. maxLength: 255 minLength: 1 type: string lifecycleDetails: description: Additional status related to the execution and current state of the Migration. enum: - READY - ABORTING - VALIDATING - VALIDATED - ASSESSED - WAITING - MIGRATING - DONE type: string x-obmcs-top-level-enum: '#/definitions/MigrationStatus' lifecycleState: description: The current state of the Migration resource. enum: - CREATING - UPDATING - ACTIVE - IN_PROGRESS - ACCEPTED - SUCCEEDED - CANCELED - WAITING - NEEDS_ATTENTION - INACTIVE - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/MigrationLifecycleStates' longTransDuration: description: 'Length of time (in seconds) that a transaction can be open before Extract generates a warning message that the transaction is long-running. If not specified, Extract will not generate a warning on long-running transactions. ' type: integer mapParallelism: default: 4 description: Number of threads used to read trail files (valid for Parallel Replicat) maximum: 100 minimum: 0 type: integer maxApplyParallelism: default: 50 description: 'Defines the range in which Replicat automatically adjusts its apply parallelism (valid for Parallel Replicat) ' type: integer metadataRemaps: description: 'Defines remapping to be applied to objects as they are processed. ' items: $ref: '#/components/schemas/MetadataRemap' type: array migrationScopeMySql: description: Assessment migration scope. enum: - SCHEMA - FULL type: string x-obmcs-top-level-enum: '#/definitions/MigrationScopeMySql' migrationScopeOracle: description: Assessment migration scope. enum: - SCHEMA - FULL type: string x-obmcs-top-level-enum: '#/definitions/MigrationScopeOracle' minApplyParallelism: default: 4 description: 'Defines the range in which Replicat automatically adjusts its apply parallelism (valid for Parallel Replicat) ' type: integer mysqlSecurityProtocol: description: Security Type for MySQL. type: string x-obmcs-enumref: '#/definitions/MysqlConnection/securityProtocol' mysqlSslCa: description: 'Database Certificate - The base64 encoded content of mysql.pem file containing the server public key (for 1 and 2-way SSL). ' maxLength: 65536 minLength: 0 type: string mysqlSslCert: description: "Client Certificate - The base64 encoded content of client-cert.pem file \ncontaining the client public key (for 2-way SSL).\n" maxLength: 65536 minLength: 0 type: string mysqlSslCrl: description: 'Certificates revoked by certificate authorities (CA). Server certificate must not be on this list (for 1 and 2-way SSL). Note: This is an optional and that too only applicable if TLS/MTLS option is selected. ' maxLength: 65536 minLength: 0 type: string mysqlSslKey: description: Client Key - The client-key.pem containing the client private key (for 2-way SSL). maxLength: 65536 minLength: 0 type: string mysqlSslMode: description: SSL modes for MySQL. type: string x-obmcs-enumref: '#/definitions/MysqlConnection/sslMode' mysqlTechnologyType: description: 'The type of MySQL source or target connection. Example: OCI_MYSQL represents OCI MySQL HeatWave Database Service ' type: string x-obmcs-enumref: '#/definitions/MysqlConnection/technologyType' namespace: description: 'Object Storage namespace. ' maxLength: 255 minLength: 1 type: string networkSpeedMegabitPerSecond: description: A network speed in Megabits per second. enum: - MBPS_10 - MBPS_100 - MBPS_1000 - MBPS_2500 - MBPS_5000 - MBPS_10000 type: string x-obmcs-top-level-enum: '#/definitions/NetworkSpeedMegabitPerSecond' nsgIds: description: 'An array of Network Security Group OCIDs used to define network access for Connections. ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array objectName: description: 'Object name. ' maxLength: 255 minLength: 1 type: string objectNamePrefix: description: 'Object name prefix. ' maxLength: 255 minLength: 1 type: string ocid: description: The OCID of the resource being referenced. maxLength: 255 minLength: 1 type: string ocidUpdate: description: The OCID of the resource being updated. maxLength: 255 minLength: 0 type: string oracleTechnologyType: description: The Oracle technology type. type: string x-obmcs-enumref: '#/definitions/OracleConnection/technologyType' password: description: 'The password (credential) used when creating or updating this resource. ' format: password maxLength: 255 minLength: 0 type: string port: description: The port to be used for the connection. maximum: 65536 minimum: 0 type: integer privateKeyFile: description: 'The base64 encoded content of the private key file (PEM file) corresponding to the API key of the fingerprint. ' maxLength: 51200 minLength: 0 type: string privateKeyPassphrase: description: The passphrase of the private key. format: password maxLength: 255 minLength: 0 type: string publicKeyFingerprint: description: The fingerprint of the API Key of the user specified by the userId. type: string region: description: The name of the region. type: string sshHost: description: 'Name of the host the SSH key is valid for. ' maxLength: 255 minLength: 1 type: string sshKey: description: 'Private SSH key string. ' maxLength: 4000 minLength: 1 type: string sshSudoLocation: description: 'Sudo location ' maxLength: 255 minLength: 1 type: string subnetId: description: OCI resource ID. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object technologySubType: description: Technology sub-type e.g. ADW_SHARED, ADW_DEDICATED, ATP_SHARED, ATP_DEDICATED maxLength: 100 minLength: 1 type: string technologyType: description: The technology type. enum: - OCI_AUTONOMOUS_DATABASE - OCI_MYSQL - ORACLE_DATABASE - ORACLE_EXADATA - AMAZON_RDS_ORACLE - AMAZON_AURORA_MYSQL - AMAZON_RDS_MYSQL - AZURE_MYSQL - GOOGLE_CLOUD_SQL_MYSQL - MYSQL_SERVER type: string x-obmcs-top-level-enum: '#/definitions/TechnologyType' tenancyId: description: The tenancy's OCID. maxLength: 255 minLength: 0 type: string timeCreated: description: 'The time when this resource was created. An RFC3339 formatted datetime string such as `2016-08-25T21:10:29.600Z`. ' format: date-time type: string timeUpdated: description: 'The time when this resource was updated. An RFC3339 formatted datetime string such as `2016-08-25T21:10:29.600Z`. ' format: date-time type: string title: description: The Assessor Action Title. maxLength: 255 minLength: 1 type: string type: description: 'The type of the migration to be performed. Example: ONLINE if no downtime is preferred for a migration. This method uses Oracle GoldenGate for replication. ' enum: - ONLINE - OFFLINE type: string x-obmcs-top-level-enum: '#/definitions/MigrationTypes' updateSubnetId: description: OCI resource ID. maxLength: 255 minLength: 0 type: string url: description: Endpoint URL. maxLength: 255 minLength: 1 type: string userDefinedPropertyType: description: The type of the user defined property. enum: - TEXT - PASSWORD - RADIO type: string username: description: 'The username (credential) used when creating or updating this resource. ' maxLength: 255 minLength: 0 type: string vaultId: description: OCI resource ID. maxLength: 255 minLength: 1 type: string wallet: description: 'The wallet contents used to make connections to a database. This attribute is expected to be base64 encoded. ' maxLength: 51200 minLength: 0 type: string x-obmcs-client-retries-enabled: true x-oracle-package: com.oracle.zdmcs