Oracle REST Data Services API

Create an import data pump job

post

/database/datapump/import

Create a Data Pump import job with the specified parameters and start it. Data and object structures can be imported from a directory in the Oracle database server or from Oracle Object Store. Refer to Oracle Data Pump documentation for a more detailed explanation of parameters. A client requires SQL Administrator or SQL Developer role to invoke this service.

Request

There are no request parameters for this operation.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

credential_name: string

Specify the name of the credential, owned by the database user, to be used to import from object storage.
datapump_dir: string

Default Value: DATA_PUMP_DIR

Specify the database directory to use.
file_name(required): string

The file name pattern to use for Data Pump import. Required when operation is IMPORT. When credential_name is specified the file_name must be a URI format for an Oracle Object Store location.
job_mode: string

Default Value: SCHEMA

Allowed Values: [ "FULL", "SCHEMA", "TABLE", "TABLESPACE" ]

Specify the Data Pump job mode.
name_expressions: array name_expressions

Used to define Metadata Filter parameters for a Data Pump job.
remap_schemas: array remap_schemas

Used to define Remap Schema parameters for an import job.
schema_expressions: array schema_expressions

Used to define Metadata Filter parameters for a Data Pump job.
tablespace_expressions: array tablespace_expressions

Used to define Metadata Filter parameters for a Data Pump job.
threads: integer

The maximum number of worker processes that can be used for the job. Set this parameter to adjust the amount of resources used for a job.

{
    "type":"object",
    "required":[
        "file_name"
    ],
    "properties":{
        "credential_name":{
            "type":"string",
            "description":"Specify the name of the credential, owned by the database user, to be used to import from object storage."
        },
        "datapump_dir":{
            "type":"string",
            "description":"Specify the database directory to use.",
            "default":"DATA_PUMP_DIR"
        },
        "job_mode":{
            "type":"string",
            "description":"Specify the Data Pump job mode.",
            "default":"SCHEMA",
            "enum":[
                "FULL",
                "SCHEMA",
                "TABLE",
                "TABLESPACE"
            ]
        },
        "threads":{
            "type":"integer",
            "description":"The maximum number of worker processes that can be used for the job. Set this parameter to adjust the amount of resources used for a job."
        },
        "file_name":{
            "type":"string",
            "description":"The file name pattern to use for Data Pump import. Required when operation is IMPORT. When credential_name is specified the file_name must be a URI format for an Oracle Object Store location."
        },
        "remap_schemas":{
            "type":"array",
            "description":"Used to define Remap Schema parameters for an import job.",
            "items":{
                "type":"object",
                "required":[
                    "source",
                    "target"
                ],
                "properties":{
                    "source":{
                        "type":"string",
                        "description":"Source schema to remap from."
                    },
                    "target":{
                        "type":"string",
                        "description":"Target schema to remap to."
                    }
                }
            }
        },
        "name_expressions":{
            "type":"array",
            "description":"Used to define Metadata Filter parameters for a Data Pump job.",
            "items":{
                "type":"object",
                "required":[
                    "expression"
                ],
                "properties":{
                    "expression":{
                        "type":"string",
                        "description":"An SQL clause to be used as a Name Expression filter."
                    }
                }
            }
        },
        "schema_expressions":{
            "type":"array",
            "description":"Used to define Metadata Filter parameters for a Data Pump job.",
            "items":{
                "type":"object",
                "required":[
                    "expression"
                ],
                "properties":{
                    "expression":{
                        "type":"string",
                        "description":"An SQL clause to be used as a Schema Expression filter."
                    }
                }
            }
        },
        "tablespace_expressions":{
            "type":"array",
            "description":"Used to define Metadata Filter parameters for a Data Pump job.",
            "items":{
                "type":"object",
                "required":[
                    "expression"
                ],
                "properties":{
                    "expression":{
                        "type":"string",
                        "description":"An SQL clause to be used as a Tablespace Expression filter."
                    }
                }
            }
        }
    }
}

Nested Schema : name_expressions

Type: array

Used to define Metadata Filter parameters for a Data Pump job.

Show Source

Array of: object items

{
    "type":"array",
    "description":"Used to define Metadata Filter parameters for a Data Pump job.",
    "items":{
        "type":"object",
        "required":[
            "expression"
        ],
        "properties":{
            "expression":{
                "type":"string",
                "description":"An SQL clause to be used as a Name Expression filter."
            }
        }
    }
}

Nested Schema : remap_schemas

Type: array

Used to define Remap Schema parameters for an import job.

Show Source

Array of: object items

{
    "type":"array",
    "description":"Used to define Remap Schema parameters for an import job.",
    "items":{
        "type":"object",
        "required":[
            "source",
            "target"
        ],
        "properties":{
            "source":{
                "type":"string",
                "description":"Source schema to remap from."
            },
            "target":{
                "type":"string",
                "description":"Target schema to remap to."
            }
        }
    }
}

Nested Schema : schema_expressions

Type: array

Used to define Metadata Filter parameters for a Data Pump job.

Show Source

Array of: object items

{
    "type":"array",
    "description":"Used to define Metadata Filter parameters for a Data Pump job.",
    "items":{
        "type":"object",
        "required":[
            "expression"
        ],
        "properties":{
            "expression":{
                "type":"string",
                "description":"An SQL clause to be used as a Schema Expression filter."
            }
        }
    }
}

Nested Schema : tablespace_expressions

Type: array

Used to define Metadata Filter parameters for a Data Pump job.

Show Source

Array of: object items

{
    "type":"array",
    "description":"Used to define Metadata Filter parameters for a Data Pump job.",
    "items":{
        "type":"object",
        "required":[
            "expression"
        ],
        "properties":{
            "expression":{
                "type":"string",
                "description":"An SQL clause to be used as a Tablespace Expression filter."
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

expression(required): string

An SQL clause to be used as a Name Expression filter.

{
    "type":"object",
    "required":[
        "expression"
    ],
    "properties":{
        "expression":{
            "type":"string",
            "description":"An SQL clause to be used as a Name Expression filter."
        }
    }
}

Nested Schema : items

Type: object

Show Source

source(required): string

Source schema to remap from.
target(required): string

Target schema to remap to.

{
    "type":"object",
    "required":[
        "source",
        "target"
    ],
    "properties":{
        "source":{
            "type":"string",
            "description":"Source schema to remap from."
        },
        "target":{
            "type":"string",
            "description":"Target schema to remap to."
        }
    }
}

Nested Schema : items

Type: object

Show Source

expression(required): string

An SQL clause to be used as a Schema Expression filter.

{
    "type":"object",
    "required":[
        "expression"
    ],
    "properties":{
        "expression":{
            "type":"string",
            "description":"An SQL clause to be used as a Schema Expression filter."
        }
    }
}

Nested Schema : items

Type: object

Show Source

expression(required): string

An SQL clause to be used as a Tablespace Expression filter.

{
    "type":"object",
    "required":[
        "expression"
    ],
    "properties":{
        "expression":{
            "type":"string",
            "description":"An SQL clause to be used as a Tablespace Expression filter."
        }
    }
}

Examples

Response

Supported Media Types

application/json

201 Response

Description of the Data Pump import job that has been created.

Root Schema : DataPumpJobsItem

Type: object

This object represents a specified Data Pump job in the database.

Show Source

attached_sessions: integer

Number of sessions attached to the job.
datapump_sessions: integer

Number of Data Pump sessions participating in the job.
degree: integer

Number of worker processes performing the operation.
job_mode: string

Mode of job.
job_name: string

User-supplied name for the job (or the default name generated by the server).
links: array links
operation: string

Type of job.
owner_name: string

User that initiated the job.
state: string

Current job state.

{
    "type":"object",
    "description":"This object represents a specified Data Pump job in the database.",
    "properties":{
        "owner_name":{
            "type":"string",
            "description":"User that initiated the job."
        },
        "job_name":{
            "type":"string",
            "description":"User-supplied name for the job (or the default name generated by the server)."
        },
        "operation":{
            "type":"string",
            "description":"Type of job."
        },
        "job_mode":{
            "type":"string",
            "description":"Mode of job."
        },
        "state":{
            "type":"string",
            "description":"Current job state."
        },
        "degree":{
            "type":"integer",
            "description":"Number of worker processes performing the operation."
        },
        "attached_sessions":{
            "type":"integer",
            "description":"Number of sessions attached to the job."
        },
        "datapump_sessions":{
            "type":"integer",
            "description":"Number of Data Pump sessions participating in the job."
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LinkRelation"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object LinkRelation

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

Nested Schema : LinkRelation

Type: object

Show Source

href(required): string
rel(required): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    },
    "required":[
        "rel",
        "href"
    ]
}

Examples

The following example shows how to create Data Pump import job by submitting a POST request on the REST resource using cURL.

curl -i -X POST -u username:password 
-d @request_body.json 
-H "Content-Type:application/json" https://rest_server_url/ords/orcl/pdbadmin/_/db-api/stable/database/datapump/import

Example of Request Body

Note:

The URL structure https://rest_server_url/resource-path, used in the preceding command has the following components:

rest_server_url is the REST server where Oracle Rest Data Server is running
The remainder of the URL includes the ORDS context root, the database identifier, the schema identifier, the version of ORDS Database API to use, and the path for this operation.

The following is an example of a request body for submitting a Data Pump request to import objects from the USERS tablespace and remap SCOTT schema objects to HR schema. In this example, the default DATA_PUMP_DIR database directory is used and it is expected that there are dump files matching the EXPDAT%U-13_12_45.DMP file name pattern.

{
  "job_mode": "SCHEMA",
  "file_name": "EXPDAT%U-13_12_45.DMP",
  "tablespace_expressions": [
    {"expression": "= 'USERS'"}
  ],
  "remap_schemas": [
    {"source": "SCOTT","target": "HR"}
  ]
}

Example of Response Header

The following example shows the response header. The Location header returns the URI that can be used to view the status of the job:

HTTP/1.1 201 Created
Content-Type: application/json
Content-Location: https://rest_server_url/ords/orcl/pdbadmin/_/db-api/stable/database/datapump/jobs/PDBADMIN,DATAPUMP_REST_IMPORT_20190906154258/
ETag: "onyB9moowJVhrJQrJ80tk3VyP3HZ9QqXHvwsmKrvnhNk/mOZF9CRFKJXIXWkKAnLtmJHssYdJ83KBCJUgqBtbQ=="
Location: https://rest_server_url/ords/orcl/pdbadmin/_/db-api/stable/database/datapump/jobs/PDBADMIN,DATAPUMP_REST_IMPORT_20190906154258/
Transfer-Encoding: chunked

Example of Response Body

The following example shows the response body with 201 returned in JSON format:


{
    "job_name": "DATAPUMP_REST_IMPORT_20190906154258",
    "owner_name": "PDBADMIN",
    "operation": "IMPORT",
    "job_mode": "SCHEMA",
    "state": "EXECUTING",
    "degree": 1,
    "attached_sessions": 0,
    "datapump_sessions": 2,
    "job_state": "EXECUTING",
    "links": [
        {
            "rel": "collection",
            "href": "https://rest_server_url/ords/orcl/pdbadmin/_/db-api/stable/database/datapump/jobs/"
        },
        {
            "rel": "describedby",
            "href": "https://rest_server_url/ords/orcl/pdbadmin/_/db-api/stable/metadata-catalog/"
        },
        {
            "rel": "related",
            "href": "https://rest_server_url/ords/orcl/pdbadmin/_/db-api/stable/database/datapump/jobs/PDBADMIN,DATAPUMP_REST_IMPORT_20190906154258/EXPDAT-2019-04-19-14_11_39.LOG"
        },
        {
            "rel": "related",
            "href": "https://rest_server_url/ords/orcl/pdbadmin/_/db-api/stable/database/datapump/jobs/PDBADMIN,DATAPUMP_REST_IMPORT_20190906154258/IMPDAT-2019-09-06-15_42_58.LOG"
        },
        {
            "rel": "self",
            "href": "https://rest_server_url/ords/orcl/pdbadmin/_/db-api/stable/database/datapump/jobs/PDBADMIN,DATAPUMP_REST_IMPORT_20190906154258/"
        }
    ]
}