1. REST API for Oracle Data Transforms
  2. Tasks
  3. DesignMigration

Imports Design Objects

post

[host-url]/dt-rest/v2/migration/import

Import objects provided by zip file indicated in the request body, which includes the object storage connection ID, import file name, and import options.

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
JSON payload with details for importing data.
Show Source
  • Allowed Values: [ "MERGE", "OVERWRITE" ]
    Enumerates the types of import options that can be performed.
    • Merge: Overwrite the target container with the source container, and then loop over the children for merging. Each child may have a different action. Child FCOs that are not in the import file will not be deleted.
    • Overwrite: Overwrite target object with source object. Any child objects remaining after import come from the source object. Note that this applies to all the child objects (If a project overwrites another, all the folders in this project will be replaced and any extra folders will be removed).
  • RuntimeJobDTO
Example:
{
    "objectStorageConnectionId":"your_obj_storage_connection_id",
    "importFileName":"your_file_name.zip",
    "importOption":"MERGE"
}
Nested Schema : RuntimeJobDTO
Match All
JSON that represents a job during runtime with additional job metadata, such as execution statistics, record statistics, and job variables.
Show Source
Nested Schema : RuntimeJobBaseDTO
Type: object
Represents a job during runtime.
Show Source
  • Allowed Values: [ "WAITING", "ERROR", "RUNNING", "DONE", "WARNING", "QUEUED", "NOT_STARTED", "PREPARING", "VALID", "INVALID" ]
    Enumerates the possible statuses of a job.
    • Waiting: The Job is waiting to be executed.
    • Error: The Job terminated due to an error.
    • Running: The Job is being executed.
    • Done: The Job executed successfully.
    • Warning: The Job completed successfully but errors have been detected during the data quality check.
    • Queued: The Job is waiting for an agent to be available for its execution.
    • Not started: The Job has not started.
    • Preparing: The Job is preparing to be executed.
    • Valid: The Job is valid to be executed.
    • Invalid: The Job is not valid to be executed.
Nested Schema : RuntimeJobDTO-allOf[1]
Type: object
JSON that represents a job during runtime with additional job metadata, such as execution statistics, record statistics, and job variables.
Show Source
Nested Schema : executionStatistics
Type: object
Complex object: ExecutionStatisticsDTO
Nested Schema : jobVariables
Type: object
Additional Properties Allowed
Show Source
Nested Schema : recordStatistics
Type: object
Complex object: RecordStatisticsDTO
Back to Top

Response

Supported Media Types

200 Response

Response object containing the job information for the Import job.
Body ()
Root Schema : schema
Type: object
JSON payload with details for importing data.
Show Source
  • Allowed Values: [ "MERGE", "OVERWRITE" ]
    Enumerates the types of import options that can be performed.
    • Merge: Overwrite the target container with the source container, and then loop over the children for merging. Each child may have a different action. Child FCOs that are not in the import file will not be deleted.
    • Overwrite: Overwrite target object with source object. Any child objects remaining after import come from the source object. Note that this applies to all the child objects (If a project overwrites another, all the folders in this project will be replaced and any extra folders will be removed).
  • RuntimeJobDTO
Example:
{
    "objectStorageConnectionId":"your_obj_storage_connection_id",
    "importFileName":"your_file_name.zip",
    "importOption":"MERGE"
}
Nested Schema : RuntimeJobDTO
Match All
JSON that represents a job during runtime with additional job metadata, such as execution statistics, record statistics, and job variables.
Show Source
Nested Schema : RuntimeJobBaseDTO
Type: object
Represents a job during runtime.
Show Source
  • Allowed Values: [ "WAITING", "ERROR", "RUNNING", "DONE", "WARNING", "QUEUED", "NOT_STARTED", "PREPARING", "VALID", "INVALID" ]
    Enumerates the possible statuses of a job.
    • Waiting: The Job is waiting to be executed.
    • Error: The Job terminated due to an error.
    • Running: The Job is being executed.
    • Done: The Job executed successfully.
    • Warning: The Job completed successfully but errors have been detected during the data quality check.
    • Queued: The Job is waiting for an agent to be available for its execution.
    • Not started: The Job has not started.
    • Preparing: The Job is preparing to be executed.
    • Valid: The Job is valid to be executed.
    • Invalid: The Job is not valid to be executed.
Nested Schema : RuntimeJobDTO-allOf[1]
Type: object
JSON that represents a job during runtime with additional job metadata, such as execution statistics, record statistics, and job variables.
Show Source
Nested Schema : executionStatistics
Type: object
Complex object: ExecutionStatisticsDTO
Nested Schema : jobVariables
Type: object
Additional Properties Allowed
Show Source
Nested Schema : recordStatistics
Type: object
Complex object: RecordStatisticsDTO

401 Response

Unauthorized

403 Response

Forbidden

404 Response

Not Found

409 Response

Conflict
Back to Top