Create a new DBCA job in the Oracle Home
/environment/homes/{homeName}/dbca/jobs/
Request
-
homeName:
Name of the Oracle Home.
Response
201 Response
Examples
The following example shows how to submit a new DBCA job in the specified 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 specified 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/homes/OraDB18Home1/dbca/jobs/
Example of Request Body
Note:
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, the path for this operation.
OraDB18Home1
is given as thehomeName
parameter value in the path. All DBCA operations are performed in Oracle Home.
The following is an example request body to create a DBCA job for deleting a database. To perform the delete action, the credentials for a user in the database with SYSDBA role must be provided as these are required by the DBCA utility.
{
"operation": "DELETE",
"global_database_name": "devdb1",
"username": "sys",
"password": "W3lc0m31"
}
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/homes/OraDB18Home1/dbca/jobs/RPKlPvbKPKqV7Ap6DN9iRg/
X-Frame-Options: SAMEORIGIN
Location: https://rest_server_url/ords/_/db-api/stable/environment/homes/OraDB18Home1/dbca/jobs/RPKlPvbKPKqV7Ap6DN9iRg/
Transfer-Encoding: chunked
Example of Response Body
The following example shows the response body with 201 returned in a JSON format:
{
"job_id": "RPKlPvbKPKqV7Ap6DN9iRg",
"description": "Running DBCA to Delete database",
"status": "RUNNING",
"submitted": "2019-09-06T19:30:06.981Z",
"finished": null,
"job_request": {
"operation": "DELETE",
"container_configuration": null,
"database_system_identifier": null,
"global_database_name": "devdb1",
"response_file": null,
"template_name": null,
"total_memory": null,
"username": "sys"
},
"dbca_log": [],
"links": [
{
"rel": "self",
"href": "https://rest_server_url/ords/_/db-api/stable/environment/homes/OraDB18Home1/dbca/jobs/RPKlPvbKPKqV7Ap6DN9iRg/"
},
{
"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/homes/OraDB18Home1/dbca/jobs/"
}
]
}