Jump to

• Request
• Response

Get a list of the databases defined in the default Oracle Home

get

/environment/databases/

Returns a description of all databases specified in the Oracle Home specified by $ORACLE_HOME environment variable. This Oracle Home 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

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Description of all databases defined in the default Oracle Home.

Body ()

Root Schema : EnvironmentDatabases

Type: object

Show Source

• count(optional): integer
  Total number of records in the current response.
• hasMore(optional): boolean
  Indicates if there are more records to be retrieved.
• items(optional): array items
• limit(optional): integer
  The actual page size limit on number of records applied by the server.
• links(optional): array links
• offset(optional): integer
  The actual index from which the item resources are returned.

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/EnvironmentDatabasesItem"
            }
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates if there are more records to be retrieved."
        },
        "limit":{
            "type":"integer",
            "description":"The actual page size limit on number of records applied by the server."
        },
        "offset":{
            "type":"integer",
            "description":"The actual index from which the item resources are returned."
        },
        "count":{
            "type":"integer",
            "description":"Total number of records in the current response."
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkRelation"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object EnvironmentDatabasesItem
  A database has a unique name within the context of the Oracle home it belongs to.

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

Nested Schema : links

Type: array

Show Source

• Array of: object LinkRelation

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

Nested 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