REST APIs for Oracle Database

Create a PDB from PDB$SEED or XML

post

/database/pdbs/

Create a pluggable database from PDB$SEED or from an XML metadata file accessible to the database instance. The use of Oracle Transparent Data Encryption is only supported in topologies where the database and Oracle REST Data Services are on the same host. This service requires db.cdb.adminUser credentials to be set in the pool configuration.

Request

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

adminName(optional): string

Specify the administrator username when creating a PDB only.
adminPwd(optional): string

Specify the administrator username when creating a PDB only.
asCopy(optional): boolean

As Copy is exclusive for PLUG operations.
copyAction(optional): string

Allowed Values: [ "COPY", "NOCOPY", "MOVE" ]

Exclusive property for PLUG operations.
fileNameConversions: string

Relevant for create and plug operations. As defined in the Oracle Multitenant Database documentation. Values can be a filename convert pattern or NONE.
getScript(optional): boolean

If defined, the response will contain a JSON object with the information of the script that was generated for execution. A database is not created when this property is set to true.
method: string

Allowed Values: [ "CREATE", "PLUG" ]

This property defines the type of operation.
pdb_name: string

New PDB name in case of a create/plug operation.
reuseTempFile(optional): boolean

Relevant for create and plug operations. True for temporary file reusage.
sourceFileNameConversions(optional): string

Relevant for plug operations. As defined in the Oracle Multitenant Database documentation. Values can be a source filename convert pattern or NONE.
tdeImport(optional): boolean

TDE import for plug operations.
tdeKeystorePath(optional): string

TDE keystore path is required if the tdeImport flag is set to true. Can be used in plug operations.
tdePassword(optional): string

TDE password when applicable (optional). Can be used in create and plug operations.
tdeSecret(optional): string

TDE secret is required if the tdeImport flag is set to true. Can be used in plug operations.
tempSize(optional): string

Relevant for create and clone operations. Total size for temporary tablespace as defined in the Oracle Multitenant Database documentation. See size_clause description in Database SQL Language Reference documentation.
totalSize(optional): string

Relevant for create and plug operations. Total size as defined in the Oracle Multitenant Database documentation. See size_clause description in Database SQL Language Reference documentation.
unlimitedStorage(optional): boolean

Relevant for create and plug operations. True for unlimited storage. Even when set to true, totalSize and tempSize MUST be specified in the request if method is CREATE.
xmlFileName(optional): string

Exclusive property for PLUG operations.

{
    "type":"object",
    "required":[
        "method",
        "pdb_name",
        "fileNameConversions"
    ],
    "properties":{
        "method":{
            "type":"string",
            "description":"This property defines the type of operation.",
            "enum":[
                "CREATE",
                "PLUG"
            ]
        },
        "adminName":{
            "type":"string",
            "description":"Specify the administrator username when creating a PDB only."
        },
        "adminPwd":{
            "type":"string",
            "description":"Specify the administrator username when creating a PDB only."
        },
        "pdb_name":{
            "type":"string",
            "description":"New PDB name in case of a create/plug operation."
        },
        "asCopy":{
            "type":"boolean",
            "description":"As Copy is exclusive for PLUG operations."
        },
        "xmlFileName":{
            "type":"string",
            "description":"Exclusive property for PLUG operations."
        },
        "copyAction":{
            "type":"string",
            "description":"Exclusive property for PLUG operations.",
            "enum":[
                "COPY",
                "NOCOPY",
                "MOVE"
            ]
        },
        "sourceFileNameConversions":{
            "type":"string",
            "description":"Relevant for plug operations. As defined in the Oracle Multitenant Database documentation. Values can be a source filename convert pattern or NONE."
        },
        "fileNameConversions":{
            "type":"string",
            "description":"Relevant for create and plug operations. As defined in the  Oracle Multitenant Database documentation. Values can be a filename convert pattern or NONE."
        },
        "unlimitedStorage":{
            "type":"boolean",
            "description":"Relevant for create and plug operations. True for unlimited storage. Even when set to true, totalSize and tempSize MUST be specified in the request if method is CREATE."
        },
        "reuseTempFile":{
            "type":"boolean",
            "description":"Relevant for create and plug operations. True for temporary file reusage."
        },
        "totalSize":{
            "type":"string",
            "description":"Relevant for create and plug operations. Total size as defined in the Oracle Multitenant Database documentation. See size_clause description in Database SQL Language Reference documentation."
        },
        "tempSize":{
            "type":"string",
            "description":"Relevant for create and clone operations. Total size for temporary tablespace as defined in the Oracle Multitenant Database documentation. See size_clause description in Database SQL Language Reference documentation."
        },
        "tdePassword":{
            "type":"string",
            "description":"TDE password when applicable (optional). Can be used in create and plug operations."
        },
        "tdeImport":{
            "type":"boolean",
            "description":"TDE import for plug operations."
        },
        "tdeKeystorePath":{
            "type":"string",
            "description":"TDE keystore path is required if the tdeImport flag is set to true. Can be used in  plug operations."
        },
        "tdeSecret":{
            "type":"string",
            "description":"TDE secret is required if the tdeImport flag is set to true. Can be used in plug operations."
        },
        "getScript":{
            "type":"boolean",
            "description":"If defined, the response will contain a JSON object with the information of the script that was generated for execution. A database is not created when this property is set to true."
        }
    }
}

Response

Supported Media Types

application/json

200 Response

The response will indicate the successful execution of a series of PL/SQL statements, or return a set of PL/SQL statements that could be executed to create a pluggable database.

Root Schema : RESTSQLCollection

Type: object

Show Source

env(optional): string
items(optional): array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SQLItem"
            }
        },
        "env":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object SQLItem

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

Nested Schema : SQLItem

Type: object

Show Source

response(optional): array response
result(optional): integer
statementId(optional): integer

{
    "type":"object",
    "properties":{
        "statementId":{
            "type":"integer"
        },
        "response":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "result":{
            "type":"integer"
        }
    }
}

Nested Schema : response

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}