REST APIs for Oracle Database

Create a new DBCA job in the default Oracle Home

post

/environment/dbca/jobs/

Submit a new Database Configuration Assistant (DBCA) job request to CREATE or DELETE a database in the Oracle Home specified by $ORACLE_HOME environment variable. This Oracle Home is expected to be on the same host as the Oracle REST Data Services server instance. A client requires System Administrator role to invoke this service.

Request

There are no request parameters for this operation.

Response

201 Response

Description of the new DBCA job.

Examples

The following example shows how to submit a new DBCA job in the default Oracle Home by submitting a POST request on the REST resource using cURL. The DBCA job can be a request to create or delete a database in the default Oracle Home.

curl -i -X POST -u username:password 
-d @request_body.json 
-H "Content-Type:application/json" https://rest_server_url/ords/_/db-api/stable/environment/dbca/jobs/

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 version of ORDS Database API to use, and the path for this operation.

The following is an example request body to create a DBCA job for creating a non-container database. The non-container database is called devdb1 based on the General_Purpose.dbc template, and the total amount of physical memory used by the new databaase is 700mb.

{
  "operation": "CREATE",
  "global_database_name": "devdb1",
  "template_name": "General_Purpose.dbc",
  "sys_user_password": "W3lc0m31",
  "system_user_password": "W3lc0m31",
  "total_memory": 700
}

Example of Response Header

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

HTTP/1.1 201 Created
Content-Type: application/json
Content-Location: https://rest_server_url/ords/_/db-api/stable/environment/dbca/jobs/OzQbsGnbUhVV7w7fiYPbJQ/
X-Frame-Options: SAMEORIGIN
Location: https://rest_server_url/ords/_/db-api/stable/environment/dbca/jobs/OzQbsGnbUhVV7w7fiYPbJQ/
Transfer-Encoding: chunked

Example of Response Body

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

{
  "job_id": "OzQbsGnbUhVV7w7fiYPbJQ",
  "description": "Run DBCA to create database",
  "status": "RUNNING",
  "submitted": "2019-09-06T19:17:23.004Z",
  "finished": null,
  "job_request": {
    "operation": "CREATE",
    "container_configuration": null,
    "database_system_identifier": null,
    "global_database_name": "devdb1",
    "response_file": null,
    "template_name": "General_Purpose.dbc",
    "total_memory": 700,
    "username": null
  },
  "dbca_log": [],
  "links": [
    {
      "rel": "self",
      "href": "https://rest_server_url/ords/_/db-api/stable/environment/dbca/jobs/OzQbsGnbUhVV7w7fiYPbJQ/"
    },
    {
      "rel": "describedby",
      "href": "https://rest_server_url/ords/_/db-api/stable/metadata-catalog/"
    },
    {
      "rel": "collection",
      "href": "https://rest_server_url/ords/_/db-api/stable/environment/dbca/jobs/"
    }
  ]
}