Jump to

• Request
• Response

Get a specific database defined in a specific Oracle Home

get

/environment/homes/{homeName}/databases/{databaseName}

Returns a description of the database specified in the Oracle Home. The Oracle Home is on the same host as the Oracle REST Data Services server instance. A client requires System Administrator role to invoke this service. The implementation is only available for Unix based operating systems.

Request

Path Parameters

• databaseName(required): string
  Name of the database.
• homeName(required): string
  Name of the Oracle Home.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Description of a database defined in the 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: array links
• name: string
  The name of the database.
• type: 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":"#/components/schemas/LinkRelation"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LinkRelation

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

Nested Schema : LinkRelation

Type: object

Show Source

• href(required): string
• rel(required): string

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

Back to Top