Jump to

• Request
• Response

Get a specified DBCA jobs created through ORDS Database API in the default Oracle Home

get

/environment/dbca/jobs/{jobId}/

Returns a description of the DBCA job created through ORDS Database API in the default Oracle Home. The default Oracle Home is specified by $ORACLE_HOME environment variable and 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

Supported Media Types

• application/json

Path Parameters

• jobId: string
  Identifier of the DBCA job.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Description of the specified DBCA job created in the default Oracle Home.

Body ()

Root Schema : EnvironmentDbcaJobsItem

Type: object

Title: EnvironmentDbcaJobsItem

Describes a Database Configuration Assistant job.

Show Source

• dbca_log(optional): array dbca_log
  The output from the DBCA process as it executes.
• description(optional): string
  DBCA job description.
• finished(optional): string
  Timestamp for when the DBCA job request finished.
• job_id(optional): string
  Unique identifier for the DBCA job in the Oracle Home.
• job_request(optional): object job_request
• links(optional): array links
• status(optional): string
  DBCA job status.
• submitted(optional): string
  Timestamp for when the DBCA job request was submitted.

{
    "title":"EnvironmentDbcaJobsItem",
    "description":"Describes a Database Configuration Assistant job.",
    "type":"object",
    "properties":{
        "job_id":{
            "description":"Unique identifier for the DBCA job in the Oracle Home.",
            "type":"string"
        },
        "description":{
            "description":"DBCA job description.",
            "type":"string"
        },
        "status":{
            "description":"DBCA job status.",
            "type":"string"
        },
        "submitted":{
            "description":"Timestamp for when the DBCA job request was submitted.",
            "type":"string"
        },
        "finished":{
            "description":"Timestamp for when the DBCA job request finished.",
            "type":"string"
        },
        "job_request":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/definitions/JobRequest"
                },
                {
                    "description":"Describes the DBCA job request."
                }
            ]
        },
        "dbca_log":{
            "description":"The output from the DBCA process as it executes.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkRelation"
            }
        }
    }
}

Nested Schema : dbca_log

Type: array

The output from the DBCA process as it executes.

Show Source

• Array of: string

{
    "description":"The output from the DBCA process as it executes.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : job_request

Type: object

Match All

Show Source

• object JobRequest
  Title: JobRequest

  Describes the DBCA job request.
• Describes the DBCA job request.

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/JobRequest"
        },
        {
            "description":"Describes the DBCA job request."
        }
    ]
}

Nested Schema : links

Type: array

Show Source

• Array of: object LinkRelation
  Title: LinkRelation

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

Nested Schema : JobRequest

Type: object

Title: JobRequest

Describes the DBCA job request.

Show Source

• container_configuration(optional): object container_configuration
• database_system_identifier(optional): string
  The database identifier.
• global_database_name(optional): string
  Global database name.
• operation(optional): string
  The DBCA operation to be performed: CREATE or DELETE.
• response_file(optional): string
  Path for response file for DBCA to use when creating a database.
• template_name(optional): string
  Path for the database template for DBCA to use when creating a database.
• total_memory(optional): string
  Total memory parameter to provide to DBCA when creating a database.
• username(optional): string
  The sysdba username for DBCA to use when deleting a database.

{
    "title":"JobRequest",
    "description":"Describes the DBCA job request.",
    "type":"object",
    "properties":{
        "operation":{
            "description":"The DBCA operation to be performed: CREATE or DELETE.",
            "type":"string"
        },
        "container_configuration":{
            "type":"object",
            "allOf":[
                {
                    "$ref":"#/definitions/ContainerConfiguration"
                },
                {
                    "description":"This object represents container configuration details for a CDB."
                }
            ]
        },
        "database_system_identifier":{
            "description":"The database identifier.",
            "type":"string"
        },
        "global_database_name":{
            "description":"Global database name.",
            "type":"string"
        },
        "response_file":{
            "description":"Path for response file for DBCA to use when creating a database.",
            "type":"string"
        },
        "template_name":{
            "description":"Path for the database template for DBCA to use when creating a database.",
            "type":"string"
        },
        "total_memory":{
            "description":"Total memory parameter to provide to DBCA when creating a database.",
            "type":"string"
        },
        "username":{
            "description":"The sysdba username for DBCA to use when deleting a database.",
            "type":"string"
        }
    }
}

Nested Schema : container_configuration

Type: object

Match All

Show Source

• object ContainerConfiguration
  Title: ContainerConfiguration

  This object represents container configuration details for a CDB.
• This object represents container configuration details for a CDB.

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/ContainerConfiguration"
        },
        {
            "description":"This object represents container configuration details for a CDB."
        }
    ]
}

Nested Schema : ContainerConfiguration

Type: object

Title: ContainerConfiguration

This object represents container configuration details for a CDB.

Show Source

• number_of_pdbs(optional): string
  Number of PDBs to create.
• pdb_name(optional): string
  Base name of each PDB. A number is appended to each name if number_of_pdbs is greater than 1.

{
    "title":"ContainerConfiguration",
    "description":"This object represents container configuration details for a CDB.",
    "type":"object",
    "properties":{
        "number_of_pdbs":{
            "description":"Number of PDBs to create.",
            "type":"string"
        },
        "pdb_name":{
            "description":"Base name of each PDB. A number is appended to each name if number_of_pdbs is greater than 1.",
            "type":"string"
        }
    }
}

Nested Schema : LinkRelation

Type: object

Title: LinkRelation

Show Source

• href: string
• rel: string

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

Back to Top