Jump to

• Request
• Response

Get a specific database defined in the default Oracle Home

get

/environment/databases/{databaseName}

Returns a description of the database specified in the default Oracle Home. The default Oracle Home is on the same host as the Oracle REST Data Services server instance and is specified using the $ORACLE_HOME environment variable. A client requires System Administrator role to invoke this service.

Request

Path Parameters

• databaseName: string
  Name of the database.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Description of a database defined in the default Oracle Home.

Body ()

Root Schema : EnvironmentDatabasesItem

Type: object

A database has a unique name within the context of the Oracle home it belongs to.

Show Source

• links(optional): array links
• name(optional): string
  The name of the database.
• type(optional): string
  The type of database. Either CDB or NON_CDB

{
    "type":"object",
    "description":"A database has a unique name within the context of the Oracle home it belongs to.",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the database."
        },
        "type":{
            "type":"string",
            "description":"The type of database. Either CDB or NON_CDB"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkRelation"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LinkRelation

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

Nested Schema : LinkRelation

Type: object

Show Source

• href: string
• rel: string

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

Back to Top