Provides the Oracle REST Data Services (ORDS) users the ability to perform Oracle Database management and monitoring operations through a user-friendly REST API. Depending on the database version and configuration, ORDS database APIs provide services such as manage pluggable databases, export data, and review database performance.
To install and configure Oracle REST Data Services refer to the Oracle® REST Data Services Installation and Configuration Guide.
An OpenAPI V3 document that describes the available ORDS database API services can be retrieved from a running ORDS instance. The API document can be imported into compatible development tools and invoked from there. The URL to retrieve the API document depends on the your configuration.
The pattern for the API document URL is:
https://<server>/<context root>/<my database>/<my schema>/_/db-api/stable/<service path>
Where, the <my database> and <my schema> variables can be optional, depending on the ORDS configuration and the service invoked.'
version: 2026.03.26
title: Oracle REST Data Services General API
contact:
name: Oracle REST Data Services
url: https://www.oracle.com/database/technologies/appdev/rest.html
x-summary: Provides the Oracle REST Data Services (ORDS) users the ability to perform Oracle Database management and monitoring operations through a user-friendly REST API.
tags:
- name: General
description: Services related to the Oracle database instance.
paths:
/database/components/:
get:
tags:
- General
summary: Get all database components
description: Returns information about the components loaded into the database from DBA_REGISTRY view. A client requires SQL Administrator role to invoke this service.
parameters:
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Filter'
responses:
'200':
description: All database components loaded into the database.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseComponents'
x-internal-id: database-components--get
x-filename-id: database-components-get
/database/components/{comp_id}:
get:
tags:
- General
summary: Get a database component
description: Returns information about the specified component loaded into the database from DBA_REGISTRY view. A client requires SQL Administrator role to invoke this service.
parameters:
- name: comp_id
in: path
description: Identifier of the component.
required: true
schema:
type: string
responses:
'200':
description: Information about the specified component.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseComponentsItem'
x-internal-id: database-components-{comp_id}-get
x-filename-id: database-components-comp_id-get
/database/connections/:
get:
tags:
- General
summary: Get a description of all local listeners for this database
description: Returns LOCAL LISTENER and SERVICE NAME records from GV$LISTENER_NETWORK for this database. A client requires SQL Administrator role to invoke this service.
parameters:
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Filter'
responses:
'200':
description: All the local listeners for this database.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseConnections'
x-internal-id: database-connections--get
x-filename-id: database-connections-get
/database/connections/{host_name},{port},{service_name}:
get:
tags:
- General
summary: Get a description of a specific local listener for this database
description: Returns LOCAL LISTENER and SERVICE NAME information from GV$LISTENER_NETWORK for a specific host, port, and service combination. A client requires SQL Administrator role to invoke this service.
parameters:
- name: host_name
in: path
description: Name of the host.
required: true
schema:
type: string
- name: port
in: path
description: Port number being listened on.
required: true
schema:
type: number
- name: service_name
in: path
description: Name of the service.
required: true
schema:
type: string
responses:
'200':
description: Information on a specific listener and service.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseConnectionsItem'
x-internal-id: database-connections-{host_name},{port},{service_name}-get
x-filename-id: database-connections-host_name-port-service_name-get
/database/datapump/jobs/:
post:
tags:
- General
summary: Create a data pump job
description: Create a Data Pump job with the specified parameters and start it. Refer to Oracle Data Pump documentation for a more detailed explanation of parameters. A client requires SQL Administrator or SQL Developer role to invoke this service.
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- operation
properties:
operation:
type: string
description: Specify the Data Pump job operation.
enum:
- EXPORT
- IMPORT
credential_name:
type: string
description: Specify the name of the credential, owned by the database user, to be used to import from object storage or export to object storage.
datapump_dir:
type: string
description: Specify the database directory to use.
default: DATA_PUMP_DIR
filter:
type: string
description: The filter to apply to identify database objects for export. This an export convenience for simple lists in metadata filter parameters, carried over from 19.1 implementation.
job_mode:
type: string
description: Specify the Data Pump job mode.
default: SCHEMA
enum:
- FULL
- SCHEMA
- TABLE
- TABLESPACE
file_name:
type: string
description: The file name pattern to use for Data Pump import. Required when operation is IMPORT or when credential_name is specified. For EXPORT the file_name will default to a pattern with a timestamp in the name. When credential_name is specified the file_name must be a URI format for an Oracle Object Store location.
threads:
type: integer
description: The maximum number of worker processes that can be used for the job. Set this parameter to adjust the amount of resources used for a job.
remap_schemas:
type: array
description: Used to define Remap Schema parameters for an import job. Only applicable for IMPORT.
items:
type: object
required:
- source
- target
properties:
source:
type: string
description: Source schema to remap from.
target:
type: string
description: Target schema to remap to.
name_expressions:
type: array
description: Used to define Metadata Filter parameters for a Data Pump job. Applicable for both EXPORT and IMPORT.
items:
type: object
required:
- expression
properties:
expression:
type: string
description: An SQL clause to be used as a Name Expression filter.
schema_expressions:
type: array
description: Used to define Metadata Filter parameters for a Data Pump job. Applicable for both EXPORT and IMPORT.
items:
type: object
required:
- expression
properties:
expression:
type: string
description: An SQL clause to be used as a Schema Expression filter.
tablespace_expressions:
type: array
description: Used to define Metadata Filter parameters for a Data Pump job. Applicable for both EXPORT and IMPORT.
items:
type: object
required:
- expression
properties:
expression:
type: string
description: An SQL clause to be used as a Tablespace Expression filter.
keep_master:
type: integer
description: The maximum number of worker processes that can be used for the job. Set this parameter to adjust the amount of resources used for a job.
default: 1
enum:
- 0
- 1
examples:
export_hr:
summary: Export the HR schema.
value:
operation: EXPORT
schema_expressions:
- expression: IN ( 'HR' )
import_hr_to_blake:
summary: Import the HR schema and map it to the BLAKE schema.
value:
operation: IMPORT
job_mode: FULL
file_name: EXPDAT%U2019-03-25-12_55_03.DMP
remap_schemas:
- source: HR
target: BLAKE
responses:
'201':
description: Details of the Data Pump job that has been successfully created.
content:
application/json:
schema:
$ref: '#/components/schemas/DataPumpJobsItem'
x-internal-id: database-datapump-jobs--post
x-filename-id: database-datapump-jobs-post
/database/feature_usage/:
get:
tags:
- General
summary: Get all feature usage statistics
description: See what features are used in the database. Returns records from DBA_FEATURE_USAGE_STATISTICS. A client requires SQL Administrator role to invoke this service.
parameters:
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Filter'
responses:
'200':
description: Feature Usage records from DBA_FEATURE_USAGE_STATISTICS.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseFeatureUsage'
x-internal-id: database-feature_usage--get
x-filename-id: database-feature_usage-get
/database/feature_usage/{dbid},{name}:
get:
tags:
- General
summary: Get usage statistic for a feature
description: Returns records from DBA_FEATURE_USAGE_STATISTICS for a specific feature. A client requires SQL Administrator role to invoke this service.
parameters:
- name: dbid
in: path
description: Database identifier as found in GV$DATABASE.
required: true
schema:
type: number
- name: name
in: path
description: Name of the feature.
required: true
schema:
type: string
responses:
'200':
description: Information on the usage statistics for a specific feature.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseFeatureUsageItem'
x-internal-id: database-feature_usage-{dbid},{name}-get
x-filename-id: database-feature_usage-dbid-name-get
/database/parameters/:
get:
tags:
- General
summary: Get all database parameters
description: Return records from GV$SYSTEM_PARAMETER. A client requires SQL Administrator role to invoke this service.
parameters:
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Filter'
responses:
'200':
description: Description of all database parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseParameters'
x-internal-id: database-parameters--get
x-filename-id: database-parameters-get
/database/parameters/{name}:
get:
tags:
- General
summary: Get a specific database parameter
description: Returns the corresponding record from GV$SYSTEM_PARAMETER. A client requires SQL Administrator role to invoke this service.
parameters:
- name: name
in: path
description: Name of the parameter.
required: true
schema:
type: string
responses:
'200':
description: Information on a specific database parameter.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseParametersItem'
x-internal-id: database-parameters-{name}-get
x-filename-id: database-parameters-name-get
/database/security/users/:
get:
tags:
- General
summary: Get all database users
description: Returns records from DBA_USERS or ALL_USERS view depending on the role at runtime. A client requires SQL Administrator or SQL Developer role to invoke this service.
parameters:
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Filter'
responses:
'200':
description: Description of all users in the database.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseUsers'
x-internal-id: database-security-users--get
x-filename-id: database-security-users-get
/database/security/users/{username}:
get:
tags:
- General
summary: Get a specific database user
description: Returns the corresponding record from DBA_USERS or ALL_USERS view depending on the role at runtime. A client requires SQL Administrator or SQL Developer role to invoke this service.
parameters:
- name: username
in: path
description: Identifier for the user.
required: true
schema:
type: string
responses:
'200':
description: Information on the specified user.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseUsersItem'
x-internal-id: database-security-users-{username}-get
x-filename-id: database-security-users-username-get
/database/sessionless-transactions/:
post:
tags:
- General
summary: Start a sessionless transaction
description: Start a new sessionless transaction.
responses:
'200':
description: Transaction started successfully
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionResponse'
example:
gtrid: de9b1f488f4244e39580987547d63e8d
status: Start transaction
'400':
description: Sessionless transactions are not supported
x-internal-id: database-sessionless-transactions--post
x-filename-id: database-sessionless-transactions-post
/database/sessionless-transactions/{sessionlessTransactionID}:
put:
tags:
- General
summary: Commit a sessionless transaction
description: Commit a sessionless transaction with the specified ID.
parameters:
- name: sessionlessTransactionID
in: path
required: true
schema:
type: string
responses:
'200':
description: Transaction committed successfully
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionResponse'
example:
gtrid: de9b1f488f4244e39580987547d63e8d
status: Committed
'400':
description: Sessionless transactions are not supported or the transaction does not exist
x-internal-id: database-sessionless-transactions-{sessionlessTransactionID}-put
x-filename-id: database-sessionless-transactions-sessionlesstransactionid-put
delete:
tags:
- General
summary: Rollback a sessionless transaction
description: Rollback a sessionless transaction with the specified ID.
parameters:
- name: sessionlessTransactionID
in: path
required: true
schema:
type: string
responses:
'200':
description: Transaction rolled back successfully
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionResponse'
example:
gtrid: de9b1f488f4244e39580987547d63e8d
status: Rolled Back
'400':
description: Sessionless transactions are not supported or the transaction does not exist
x-internal-id: database-sessionless-transactions-{sessionlessTransactionID}-delete
x-filename-id: database-sessionless-transactions-sessionlesstransactionid-delete
/database/status:
get:
tags:
- General
summary: Get database status
description: Returns records from GV$INSTANCE and GV$DATABASE. A client requires SQL Administrator role to invoke this service.
responses:
'200':
description: Description of the database state.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseStatusItem'
x-internal-id: database-status-get
x-filename-id: database-status-get
/database/storage/bytes:
get:
tags:
- General
summary: Get storage statistics
description: Returns info on bytes allocated for storage and how much is used. Using DBA_DATA_FILES data to calculate the total bytes allocated for storage along with DBA_TABLESPACE_USAGE_METRICS and DBA_TABLESPACES data to calculate the used bytes. A client requires SQL Administrator role to invoke this service.
responses:
'200':
description: Total bytes across all the data files and how much is used.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseStorageBytesItem'
x-internal-id: database-storage-bytes-get
x-filename-id: database-storage-bytes-get
/database/storage/tablespaces/:
get:
tags:
- General
summary: Get all tablespaces storage data
description: Returns records from DBA_TABLESPACES along with data usage information from DBA_TABLESPACE_USAGE_METRICS. A client requires SQL Administrator role to invoke this service.
parameters:
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Filter'
responses:
'200':
description: Description of all tablespaces in the database.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseTablespaces'
x-internal-id: database-storage-tablespaces--get
x-filename-id: database-storage-tablespaces-get
/database/storage/tablespaces/{tablespace_name}/:
get:
tags:
- General
summary: Get storage for a specific tablespace
description: Returns data from DBA_TABLESPACES along with data usage information from DBA_TABLESPACE_USAGE_METRICS for a specific tablespace. A client requires SQL Administrator role to invoke this service.
parameters:
- name: tablespace_name
in: path
description: Name of the tablespace.
required: true
schema:
type: string
responses:
'200':
description: Tablespace information, including data usage, is returned. The response structure may vary depending on the database.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseTablespacesItem'
x-internal-id: database-storage-tablespaces-{tablespace_name}--get
x-filename-id: database-storage-tablespaces-tablespace_name-get
/database/storage/tablespaces/{tablespace_name}/datafiles_usage:
get:
tags:
- General
summary: Get data file usage summary for a specific tablespace
description: Returns GV$DATAFILE and DBA_DATA_FILES records for a specific tablespace. A client requires SQL Administrator role to invoke this service.
parameters:
- name: tablespace_name
in: path
description: Name of the tablespace.
required: true
schema:
type: string
responses:
'200':
description: Tablespace data file usage.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseTablespaceDatafilesUsageItem'
x-internal-id: database-storage-tablespaces-{tablespace_name}-datafiles_usage-get
x-filename-id: database-storage-tablespaces-tablespace_name-datafiles_usage-get
/database/storage/tablespaces/{tablespace_name}/datafiles/:
get:
tags:
- General
summary: Get data files for a tablespace
description: Returns records from DBA_DATA_FILES for a specific tablespace. A client requires SQL Administrator role to invoke this service.
parameters:
- name: tablespace_name
in: path
description: Name of the tablespace.
required: true
schema:
type: string
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Filter'
responses:
'200':
description: Description of all data files for a specific tablespace.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseTablespaceDatafiles'
x-internal-id: database-storage-tablespaces-{tablespace_name}-datafiles--get
x-filename-id: database-storage-tablespaces-tablespace_name-datafiles-get
/database/storage/tablespaces/{tablespace_name}/datafiles/{file_id}/:
get:
tags:
- General
summary: Get tablespace data file
description: Returns data from DBA_DATA_FILES for a specific tablespace and file. A client requires SQL Administrator role to invoke this service.
parameters:
- name: tablespace_name
in: path
description: Name of the tablespace.
required: true
schema:
type: string
- name: file_id
in: path
description: File identifier.
required: true
schema:
type: string
responses:
'200':
description: Information about the specified data file.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseTablespaceDatafilesItem'
x-internal-id: database-storage-tablespaces-{tablespace_name}-datafiles-{file_id}--get
x-filename-id: database-storage-tablespaces-tablespace_name-datafiles-file_id-get
/database/storage/tablespaces/{tablespace_name}/datafiles/{file_id}/usage:
get:
tags:
- General
summary: Get tablespace data file usage
description: Returns GV$DATAFILE and DBA_DATA_FILES records for a specific tablespace and file. A client requires SQL Administrator role to invoke this service.
parameters:
- name: tablespace_name
in: path
description: Name of the tablespace.
required: true
schema:
type: string
- name: file_id
in: path
description: File identifier.
required: true
schema:
type: string
responses:
'200':
description: Description of the space usage for the tablespace data file.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseTablespaceDatafileUsageItem'
x-internal-id: database-storage-tablespaces-{tablespace_name}-datafiles-{file_id}-usage-get
x-filename-id: database-storage-tablespaces-tablespace_name-datafiles-file_id-usage-get
/database/storage/tablespaces/{tablespace_name}/history:
get:
tags:
- General
summary: Get tablespace space usage history
description: Oracle Diagnostic Pack licence is required for this service. Returns DBA_HIST_TBSPC_SPACE_USAGE records where tablespace size has changed. These records are historical tablespace usage statistics. Recent changes in tablespace storage or usage will not appear until a snapshot is created. A client requires SQL Administrator role to invoke this service.
parameters:
- name: tablespace_name
in: path
description: Name of the tablespace.
required: true
schema:
type: string
responses:
'200':
description: Tablespace space usage history for the specified tablespace.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseTablespaceHistoryItem'
x-internal-id: database-storage-tablespaces-{tablespace_name}-history-get
x-filename-id: database-storage-tablespaces-tablespace_name-history-get
/database/storage/tablespaces/{tablespace_name}/segments/:
get:
tags:
- General
summary: Get tablespace segments
description: Returns records from DBA_SEGMENTS for a specific tablespace. A client requires SQL Administrator role to invoke this service.
parameters:
- name: tablespace_name
in: path
description: Name of the tablespace.
required: true
schema:
type: string
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Filter'
responses:
'200':
description: Collection of records from DBA_SEGMENTS for the specified tablespace.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseTablespaceSegments'
x-internal-id: database-storage-tablespaces-{tablespace_name}-segments--get
x-filename-id: database-storage-tablespaces-tablespace_name-segments-get
/database/storage/tablespaces/{tablespace_name}/segments/{segment_name}:
get:
tags:
- General
summary: Get a tablespace segment
description: Returns data from DBA_SEGMENTS for a specific tablespace and segment. A client requires SQL Administrator role to invoke this service.
parameters:
- name: tablespace_name
in: path
description: Name of the tablespace.
required: true
schema:
type: string
- name: segment_name
in: path
description: Name of the segment.
required: true
schema:
type: string
responses:
'200':
description: A specific record from DBA_SEGMENTS for the tablespace and segment name.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseTablespaceSegmentsItem'
x-internal-id: database-storage-tablespaces-{tablespace_name}-segments-{segment_name}-get
x-filename-id: database-storage-tablespaces-tablespace_name-segments-segment_name-get
/database/storage/tablespaces/{tablespace_name}/tempfiles_usage:
get:
tags:
- General
summary: Get temporary file usage summary for a specific tablespace
description: Returns records from GV$TEMPFILE and DBA_TEMP_FILES for a specific tablespace. A client requires SQL Administrator role to invoke this service.
parameters:
- name: tablespace_name
in: path
description: Name of the tablespace.
required: true
schema:
type: string
responses:
'200':
description: Summary information of all temporary files used by the tablespace.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseTablespaceDatafilesUsageItem'
x-internal-id: database-storage-tablespaces-{tablespace_name}-tempfiles_usage-get
x-filename-id: database-storage-tablespaces-tablespace_name-tempfiles_usage-get
/database/storage/tablespaces/{tablespace_name}/tempfiles/:
get:
tags:
- General
summary: Get temporary files for a tablespace
description: Returns records from DBA_TEMP_FILES for a specific tablespace. A client requires SQL Administrator role to invoke this service.
parameters:
- name: tablespace_name
in: path
description: Name of the tablespace.
required: true
schema:
type: string
- $ref: '#/components/parameters/Limit'
- $ref: '#/components/parameters/Filter'
responses:
'200':
description: Description of all temporary files used by the specified tablespace.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseTablespaceTempfiles'
x-internal-id: database-storage-tablespaces-{tablespace_name}-tempfiles--get
x-filename-id: database-storage-tablespaces-tablespace_name-tempfiles-get
/database/storage/tablespaces/{tablespace_name}/tempfiles/{file_id}/:
get:
tags:
- General
summary: Get tablespace temporary file
description: Returns data from DBA_TEMP_FILES for a specific tablespace and file. A client requires SQL Administrator role to invoke this service.
parameters:
- name: tablespace_name
in: path
description: Name of the tablespace.
required: true
schema:
type: string
- name: file_id
in: path
description: File identifier.
required: true
schema:
type: string
responses:
'200':
description: Information about the specified temporary file.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseTablespaceTempfilesItem'
x-internal-id: database-storage-tablespaces-{tablespace_name}-tempfiles-{file_id}--get
x-filename-id: database-storage-tablespaces-tablespace_name-tempfiles-file_id-get
/database/storage/tablespaces/{tablespace_name}/tempfiles/{file_id}/usage:
get:
tags:
- General
summary: Get tablespace temporary file usage
description: Returns GV$DATAFILE and DBA_TEMP_FILES records for a specific tablespace and file. A client requires SQL Administrator role to invoke this service.
parameters:
- name: tablespace_name
in: path
description: Name of the tablespace.
required: true
schema:
type: string
- name: file_id
in: path
description: File identifier.
required: true
schema:
type: string
responses:
'200':
description: Usage information about the temporary file.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseTablespaceDatafileUsageItem'
x-internal-id: database-storage-tablespaces-{tablespace_name}-tempfiles-{file_id}-usage-get
x-filename-id: database-storage-tablespaces-tablespace_name-tempfiles-file_id-usage-get
/database/version:
get:
tags:
- General
summary: Get database version
description: Returns records from GV$INSTANCE and GV$VERSION. A client requires SQL Administrator role to invoke this service.
responses:
'200':
description: Version information about the database.
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseVersionItem'
x-internal-id: database-version-get
x-filename-id: database-version-get
/environment/homes/{homeName}/:
get:
tags:
- General
summary: Get specific database Oracle Home
description: Returns a description for a specific Oracle Home 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.
parameters:
- name: homeName
in: path
description: Name of the Oracle Home.
required: true
schema:
type: string
responses:
'200':
description: Description of the Oracle Home.
content:
application/json:
schema:
$ref: '#/components/schemas/EnvironmentHomesItem'
x-internal-id: environment-homes-{homeName}--get
x-filename-id: environment-homes-homename-get
components:
schemas:
DatabaseStatusItem:
type: object
description: Relying on GV$INSTANCE and GV$DATABASE views this object provides information on the status of the database.
properties:
inst_id:
type: integer
description: Instance number from which the associated GV$INSTANCE view information was obtained.
instance_number:
type: integer
description: Instance number used for instance registration (corresponds to the INSTANCE_NUMBER initialization parameter).
instance_name:
type: string
description: Name of the instance.
host_name:
type: string
description: Name of the host machine.
version:
type: string
description: Database version.
version_legacy:
type: string
description: The legacy database version used before Oracle Database 18c. This column displays the same value as the VERSION column.
version_full:
type: string
description: The version string with the new Oracle Database version scheme introduced in Oracle Database 18c.
startup_time:
type: string
description: Time when the instance was started.
status:
type: string
description: Status of the instance.
parallel:
type: string
description: Indicates whether the instance is mounted in cluster database mode (YES) or not (NO).
thread#:
type: integer
description: Redo thread opened by the instance.
archiver:
type: string
description: Automatic archiving status.
log_switch_wait:
type: string
description: Event that log switching is waiting for.
logins:
type: string
description: Indicates whether the instance is in unrestricted mode, allowing logins by all users (ALLOWED, or in restricted mode, allowing logins by database administrators only (RESTRICTED).
shutdown_pending:
type: string
description: Indicates whether a shutdown is pending (YES) or not (NO).
database_status:
type: string
description: Status of the database.
instance_role:
type: string
description: Indicates whether the instance is an active instance (PRIMARY_INSTANCE) or an inactive secondary instance (SECONDARY_INSTANCE), or UNKNOWN if the instance has been started but not mounted.
active_state:
type: string
description: Quiesce state of the instance.
blocked:
type: string
description: Indicates whether all services are blocked (YES) or not (NO).
con_id:
type: integer
description: The ID of the container to which the data pertains.
instance_mode:
type: string
description: Shows the instance mode of the current instance.
edition:
type: string
description: The edition of the database.
database_type:
type: string
description: Database type.
name:
type: string
description: Name of the database.
db_unique_name:
type: string
description: Unique database name.
open_mode:
type: string
description: Open mode information.
links:
type: array
items:
$ref: '#/components/schemas/LinkRelation'
DatabaseVersionItem:
type: object
description: Relying on GV$INSTANCE and GV$VERSION views this object provides information on the version of the database.
properties:
inst_id:
type: integer
description: Instance number from which the associated GV$INSTANCE view information was obtained.
instance_number:
type: integer
description: Instance number used for instance registration (corresponds to the INSTANCE_NUMBER initialization parameter).
instance_name:
type: string
description: Name of the instance.
host_name:
type: string
description: Name of the host machine.
version:
type: string
description: Database version.
version_legacy:
type: string
description: The legacy database version used before Oracle Database 18c. This column displays the same value as the VERSION column.
version_full:
type: string
description: The version string with the new Oracle Database version scheme introduced in Oracle Database 18c.
startup_time:
type: string
description: Time when the instance was started.
status:
type: string
description: Status of the instance.
parallel:
type: string
description: Indicates whether the instance is mounted in cluster database mode (YES) or not (NO).
thread#:
type: integer
description: Redo thread opened by the instance.
archiver:
type: string
description: Automatic archiving status.
log_switch_wait:
type: string
description: Event that log switching is waiting for.
logins:
type: string
description: Indicates whether the instance is in unrestricted mode, allowing logins by all users (ALLOWED, or in restricted mode, allowing logins by database administrators only (RESTRICTED).
shutdown_pending:
type: string
description: Indicates whether a shutdown is pending (YES) or not (NO).
database_status:
type: string
description: Status of the database.
instance_role:
type: string
description: Indicates whether the instance is an active instance (PRIMARY_INSTANCE) or an inactive secondary instance (SECONDARY_INSTANCE), or UNKNOWN if the instance has been started but not mounted.
active_state:
type: string
description: Quiesce state of the instance.
blocked:
type: string
description: Indicates whether all services are blocked (YES) or not (NO).
con_id:
type: integer
description: The ID of the container to which the data pertains.
instance_mode:
type: string
description: Shows the instance mode of the current instance.
edition:
type: string
description: The edition of the database.
database_type:
type: string
description: Database type.
instance_version:
type: array
items:
type: object
properties:
banner:
type: string
description: Component name and version number.
links:
type: array
items:
$ref: '#/components/schemas/LinkRelation'
DatabaseTablespaceSegmentsItem:
type: object
description: Describes the storage allocated for a segments in the database.
properties:
owner:
type: string
description: Username of the segment owner.
segment_name:
type: string
description: Name, if any, of the segment.
partition_name:
type: string
description: Object Partition Name (Set to NULL for nonpartitioned objects).
segment_type:
type: string
description: Type of segment.
segment_subtype:
type: string
description: 'Subtype of LOB segment: SECUREFILE, ASSM, MSSM, and NULL.'
tablespace_name:
type: string
description: Name of the tablespace containing the segment.
header_file:
type: integer
description: ID of the file containing the segment header.
header_block:
type: integer
description: ID of the block containing the segment header.
bytes:
type: integer
description: Size, in bytes, of the segment.
blocks:
type: integer
description: Size, in Oracle blocks, of the segment.
extents:
type: integer
description: Number of extents allocated to the segment.
initial_extent:
type: integer
description: Size in bytes requested for the initial extent of the segment at create time. Oracle rounds the extent size to multiples of 5 blocks if the requested size is greater than 5 blocks.
next_extent:
type: integer
description: Size in bytes of the next extent to be allocated to the segment.
min_extents:
type: integer
description: Minimum number of extents allowed in the segment.
max_extents:
type: integer
description: Maximum number of extents allowed in the segment.
max_size:
type: integer
description: Maximum number of blocks allowed in the segment.
retention:
type: string
description: Retention option for SECUREFILE segment.
minretention:
type: integer
description: Minimum retention duration for SECUREFILE segment.
pct_increase:
type: integer
description: Percent by which to increase the size of the next extent to be allocated.
freelists:
type: integer
description: Number of process freelists allocated to this segment.
freelist_groups:
type: integer
description: Number of freelist groups allocated to this segment.
relative_fno:
type: integer
description: Relative file number of the segment header.
buffer_pool:
type: string
description: Buffer pool to be used for segment blocks.
flash_cache:
type: string
description: Database Smart Flash Cache hint to be used for segment blocks.
cell_flash_cache:
type: string
description: Cell flash cache hint to be used for segment blocks.
inmemory:
type: string
description: Indicates whether the In-Memory Column Store (IM column store) is enabled (ENABLED) or disabled (DISABLED) for this segment.
inmemory_priority:
type: string
description: Indicates the priority for In-Memory Column Store (IM column store) population.
inmemory_distribute:
type: string
description: Indicates how the IM column store is distributed in an Oracle Real Application Clusters (Oracle RAC) environment.
inmemory_duplicate:
type: string
description: Indicates the duplicate setting for the IM column store in an Oracle RAC environment.
inmemory_compression:
type: string
description: Indicates the compression level for the IM column store.
cellmemory:
type: string
description: The value for columnar compression in the storage cell flash cache.
links:
type: array
items:
$ref: '#/components/schemas/LinkRelation'
DatabaseTablespaceSegments:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/DatabaseTablespaceSegmentsItem'
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: '#/components/schemas/LinkRelation'
DataPumpJobsItem:
type: object
description: This object represents a specified Data Pump job in the database.
properties:
owner_name:
type: string
description: User that initiated the job.
job_name:
type: string
description: User-supplied name for the job (or the default name generated by the server).
operation:
type: string
description: Type of job.
job_mode:
type: string
description: Mode of job.
state:
type: string
description: Current job state.
degree:
type: integer
description: Number of worker processes performing the operation.
attached_sessions:
type: integer
description: Number of sessions attached to the job.
datapump_sessions:
type: integer
description: Number of Data Pump sessions participating in the job.
links:
type: array
items:
$ref: '#/components/schemas/LinkRelation'
DatabaseUsersItem:
type: object
description: This object describes a database user. The list of attributes may vary depending on database version.
properties:
username:
type: string
description: Name of the user.
user_id:
type: integer
description: ID number of the user.
account_status:
type: string
description: Account status.
lock_date:
type: string
description: Date the account was locked if account status was LOCKED.
expiry_date:
type: string
description: Date of expiration of the account.
default_tablespace:
type: string
description: Default tablespace for data.
temporary_tablespace:
type: string
description: Name of the default tablespace for temporary tables or the name of a tablespace group.
local_temp_tablespace:
type: string
description: Default local temporary tablespace for the user.
created:
type: string
description: User creation date.
profile:
type: string
description: User resource profile name.
initial_rsrc_consumer_group:
type: string
description: Initial resource consumer group for the user.
external_name:
type: string
description: User external name. For centrally managed users, if the database user mapping is an exclusive mapping, then this will be the directory service DN for the user. If this database user is a shared schema, it will be the DN of a group.
password_versions:
type: string
description: Shows the list of versions of the password hashes (also known as 'verifiers') existing for the account.
editions_enabled:
type: string
description: Indicates whether editions have been enabled for the corresponding user (Y) or not (N).
authentication_type:
type: string
description: Indicates the authentication mechanism for the user.
proxy_only_connect:
type: string
description: Indicates whether a user can connect directly (N) or whether the account can only be proxied (Y) by users who have proxy privileges for this account (that is, by users who have been granted the 'connect through' privilege for this account).
common:
type: string
description: Indicates whether a given user is common.
last_login:
type: string
description: The time of the last user login.
oracle_maintained:
type: string
description: Denotes whether the user was created, and is maintained, by Oracle-supplied scripts (such as catalog.sql or catproc.sql). A user for which this column has the value Y must not be changed in any way except by running an Oracle-supplied script.
inherited:
type: string
description: Indicates whether the user definition was inherited from another container (YES) or not (NO).
default_collation:
type: string
description: Default collation for the user???s schema.
implicit:
type: string
description: Indicates whether this user is a common user created by an implicit application (YES) or not (NO).
all_shard:
type: string
description: In a sharded database, the value in this column indicates whether the user was created with shard DDL enabled.
locked_account:
type: integer
description: When LOCK_DATE is set, 1, otherwise 0.
expired_account:
type: integer
description: When EXPIRY_DATE is in the past, 1, otherwise 0.
open_account:
type: integer
description: When ACCOUNT_STATUS = 'OPEN', 1, otherwise 0.
days_left:
type: integer
description: Indicates the number of days left before the account expires. Can be a negative value if the account is expired.
links:
type: array
items:
$ref: '#/components/schemas/LinkRelation'
DatabaseUsers:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/DatabaseUsersItem'
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: '#/components/schemas/LinkRelation'
DatabaseTablespacesItem:
type: object
description: Describes a tablespace in the database.
properties:
tablespace_name:
type: string
description: Name of the tablespace.
file_name:
type: string
description: Name of the database file.
file_id:
type: integer
description: File identifier number of the database file.
bytes:
type: integer
description: Size of the file (in bytes).
blocks:
type: integer
description: Size of the file (in Oracle blocks).
status:
type: string
description: File status.
relative_fno:
type: integer
description: Tablespace-relative file number.
autoextensible:
type: string
description: Indicates whether the file is autoextensible (YES) or not (NO).
maxbytes:
type: integer
description: Maximum size of the file (in bytes).
maxblocks:
type: integer
description: Maximum size of the file (in Oracle blocks).
increment_by:
type: integer
description: Default increment for autoextension (in Oracle blocks).
user_bytes:
type: integer
description: The size of the file available for user data. The actual size of the file minus the USER_BYTES value is used to store file related metadata.
user_blocks:
type: integer
description: Size of the useful portion of the file (in Oracle blocks).
online_status:
type: string
description: Online status of the file.
total_space:
type: integer
description: Total size of the files (in bytes).
used_space:
type: integer
description: Total used space (in bytes).
free_space:
type: integer
description: Total free space (in bytes).
links:
type: array
items:
$ref: '#/components/schemas/LinkRelation'
DatabaseTablespaceTempfiles:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/DatabaseTablespaceTempfilesItem'
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: '#/components/schemas/LinkRelation'
DatabaseComponents:
type: object
description: DBA_REGISTRY displays information about all components in the database that are loaded into the component registry. The component registry tracks components that can be separately loaded into the Oracle Database. When a SQL script loads the PL/SQL packages and other database objects for a component into the database, the script records the component name, status, and version. If scripts are used to upgrade/downgrade the dictionary elements for the component, then those scripts also record status and version information.
properties:
items:
type: array
items:
$ref: '#/components/schemas/DatabaseComponentsItem'
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: '#/components/schemas/LinkRelation'
DatabaseTablespaces:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/DatabaseTablespacesItem'
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: '#/components/schemas/LinkRelation'
DatabaseConnectionsItem:
type: object
description: Information on the listeners configured for the database is retrieved from GV$LISTENER_NETWORK. The list of attributes may vary depending on database version.
properties:
inst_id:
type: integer
description: Instance number from which the associated GV$LISTENER_NETWORK view information was obtained.
host_name:
type: string
description: Name of the host machine.
con_id:
type: integer
description: The ID of the container to which the data pertains.
service_name:
type: string
description: Name of the database service that is registered with the listener.
port:
type: integer
description: The TCP/IP port the listener is using.
links:
type: array
items:
$ref: '#/components/schemas/LinkRelation'
DatabaseFeatureUsage:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/DatabaseFeatureUsageItem'
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: '#/components/schemas/LinkRelation'
DatabaseTablespaceTempfilesItem:
type: object
description: Describes a temporary file in the database.
properties:
file_name:
type: string
description: Name of the database file.
file_id:
type: integer
description: File identifier number of the database temp file.
tablespace_name:
type: string
description: Name of the tablespace.
bytes:
type: integer
description: Size of the file (in bytes).
blocks:
type: integer
description: Size of the file (in Oracle blocks).
status:
type: string
description: File status.
relative_fno:
type: integer
description: Tablespace-relative file number.
autoextensible:
type: string
description: Indicates whether the file is autoextensible (YES) or not (NO).
maxbytes:
type: integer
description: Maximum size of the file (in bytes).
maxblocks:
type: integer
description: Maximum size of the file (in Oracle blocks).
increment_by:
type: integer
description: Default increment for autoextension (in Oracle blocks).
user_bytes:
type: integer
description: The size of the file available for user data. The actual size of the file minus the USER_BYTES value is used to store file related metadata.
user_blocks:
type: integer
description: Size of the useful portion of the file (in Oracle blocks).
shared:
type: string
description: Type of tablespace this file belongs to.
inst_id:
type: integer
description: Instance ID of the instance to which the temp file belongs. This column has a NULL value for temp files that belong to shared tablespaces.
links:
type: array
items:
$ref: '#/components/schemas/LinkRelation'
DatabaseFeatureUsageItem:
type: object
description: Statistics on the usage in the database for an Oracle Database feature.
properties:
dbid:
type: integer
description: Database identifier of the database being tracked.
name:
type: string
description: Name of the feature.
version:
type: string
description: Database version in which the feature was tracked.
detected_usages:
type: integer
description: Number of times the system has detected usage for the feature.
total_samples:
type: integer
description: Number of times the system has woken up and checked for feature usage.
currently_used:
type: string
description: Indicates whether usage was detected the last time the system checked (TRUE) or not (FALSE).
first_usage_date:
type: string
description: First sample time the system detected usage of the feature.
last_usage_date:
type: string
description: Last sample time the system detected usage of the feature.
aux_count:
type: integer
description: This column stores feature-specific usage data in number format.
feature_info:
type: string
description: This column stores feature-specific usage data in character format.
last_sample_date:
type: string
description: The last time the system checked for usage.
last_sample_period:
type: integer
description: Amount of time (in seconds) between the last two usage sample times.
sample_interval:
type: integer
description: Sample interval.
description:
type: string
description: Description of the feature and usage detection logic.
links:
type: array
items:
$ref: '#/components/schemas/LinkRelation'
LinkRelation:
type: object
properties:
rel:
type: string
href:
type: string
required:
- rel
- href
DatabaseTablespaceHistoryItem:
type: object
description: Describes historical tablespace usage statistics.
properties:
snap_id:
type: integer
description: Unique snapshot ID.
dbid:
type: integer
description: Database ID for the snapshot.
tablespace_id:
type: integer
description: Tablespace ID.
tablespace_size:
type: integer
description: Tablespace size (in database blocks).
tablespace_maxsize:
type: integer
description: Maximum size of the tablespace (in database blocks).
tablespace_usedsize:
type: integer
description: Used size of the tablespace (in database blocks).
rtime:
type: string
description: Runtime.
con_dbid:
type: integer
description: The database ID of the PDB for the sampled session.
con_id:
type: integer
description: The ID of the container that CON_DBID identifies.
prev_tablespace_size:
type: integer
description: The previous tablespace size (in database blocks).
name:
type: string
description: Tablespace name.
DatabaseParameters:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/DatabaseParametersItem'
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: '#/components/schemas/LinkRelation'
Filter:
type: object
description: See Oracle REST Data Services production documentation 'Filtering in Queries' section.
externalDocs:
url: https://docs.oracle.com/en/database/oracle/oracle-rest-data-services/
anyOf:
- type: object
description: Any key / value pair for specifying a Filter Criteria.
- type: object
properties:
$orderby:
description: Specify which properties to order the result set by.
type: object
$asof:
description: Specify a time related query parameter to limit the results. Parameter value can be a System Change Number or a Date.
type: object
DatabaseComponentsItem:
type: object
description: A component registered in the database.
properties:
comp_id:
type: string
description: Component identifier.
comp_name:
type: string
description: Component name.
version:
type: string
description: Component version loaded.
version_full:
type: string
description: Component full version.
status:
type: string
description: Component status.
modified:
type: string
description: Time when the component was last modified.
namespace:
type: string
description: Component namespace.
control:
type: string
description: User that created the component entry.
schema:
type: string
description: User that contains the objects for the component.
procedure:
type: string
description: Validation procedure.
startup:
type: string
description: Indicates whether the component requires a startup after the upgrade (REQUIRED) or not.
parent_id:
type: string
description: Parent component identifier.
other_schemas:
type: string
description: A list of ancillary schema names associated with the component.
links:
type: array
items:
$ref: '#/components/schemas/LinkRelation'
DatabaseTablespaceDatafilesItem:
type: object
description: ''
properties:
file_name:
type: string
description: Name of the database file.
tablespace:
type: string
description: Name of the tablespace.
bytes:
type: integer
description: Size of the file (in bytes).
blocks:
type: integer
description: Size of the file (in Oracle blocks).
status:
type: string
description: File status.
relative_fno:
type: integer
description: Tablespace-relative file number.
autoextensible:
type: string
description: Indicates whether the file is autoextensible (YES) or not (NO).
maxbytes:
type: integer
description: Maximum size of the file (in bytes).
maxblocks:
type: integer
description: Maximum size of the file (in Oracle blocks).
increment_by:
type: integer
description: Default increment for autoextension (in Oracle blocks).
user_bytes:
type: integer
description: The size of the file available for user data. The actual size of the file minus the USER_BYTES value is used to store file related metadata.
user_blocks:
type: integer
description: Size of the useful portion of the file (in Oracle blocks).
online_status:
type: string
description: Online status of the file.
lost_write_protect:
type: integer
description: Lost write protection status of the file.
links:
type: array
items:
$ref: '#/components/schemas/LinkRelation'
DatabaseTablespaceDatafilesUsageItem:
type: object
description: Using GV$DATAFILE and DBA_FREE_SPACE data this object represents the usage of a data file in the database.
properties:
items:
type: array
items:
type: object
properties:
file_name:
type: string
description: Name of the database file.
tablespace:
type: string
description: Name of the tablespace.
status:
type: string
description: File status.
total_space:
type: integer
description: Total size of the files (in bytes).
used_space:
type: integer
description: Total used space (in bytes).
used_space_pct:
type: number
description: :Percentage of how much space is used.
autoextend:
type: string
description: Indicates whether the file is autoextensible (YES) or not (NO).
links:
type: array
items:
$ref: '#/components/schemas/LinkRelation'
EnvironmentHomesItem:
type: object
description: An Oracle home is a directory into which Oracle software is installed.
properties:
name:
type: string
description: The name of the Oracle home.
version:
type: string
description: The product version.
default:
type: boolean
description: Indicates if the Oracle home is specified by the $ORACLE_HOME environment variable.
read_only_home:
type: boolean
description: Indicates if the Oracle home is configured in read only mode.
links:
type: array
items:
$ref: '#/components/schemas/LinkRelation'
DatabaseParametersItem:
type: object
description: This documentation represents an initialization parameter that is currently in effect for the instance. A new session inherits parameter values from the instance-wide values. The list of attributes may vary depending on database version.
properties:
inst_id:
type: integer
description: Instance number from which the associated GV$SYSTEM_PARAMETER view information was obtained.
num:
type: integer
description: Parameter number.
name:
type: string
description: Name of the parameter.
type:
type: integer
description: Parameter type.
value:
type: string
description: Instance-wide parameter value.
display_value:
type: string
description: Parameter value in a user-friendly format. For example, if the VALUE column shows the value 262144 for a big integer parameter, then the DISPLAY_VALUE column will show the value 256K.
default_value:
type: string
description: The default value for this parameter. This is the value of the parameter if a value is not explicitly specified for the parameter.
isdefault:
type: string
description: Indicates whether the parameter is set to the default value (TRUE) or the parameter value was specified in the parameter file (FALSE). The database sets the value of the ISDEFAULT column to TRUE for parameters that are not specified in the init.ora or server parameter file (SPFILE).
isses_modifiable:
type: string
description: Indicates whether the parameter can be changed with ALTER SESSION (TRUE) or not (FALSE).
issys_modifiable:
type: string
description: Indicates whether the parameter can be changed with ALTER SYSTEM and when the change takes effect.
ispdb_modifiable:
type: string
description: Indicates whether the parameter can be modified inside a PDB (TRUE) or not (FALSE). In a non-CDB, the value of this column is NULL.
isinstance_modifiable:
type: string
description: For parameters that can be changed with ALTER SYSTEM, indicates whether the value of the parameter can be different for every instance (TRUE) or whether the parameter must have the same value for all Real Application Clusters instances (FALSE). If the ISSYS_MODIFIABLE column is FALSE, then this column is always FALSE.
ismodified:
type: string
description: Indicates how the parameter was modified. If an ALTER SYSTEM was performed, the value will be MODIFIED.
isadjusted:
type: string
description: Indicates whether Oracle adjusted the input value to a more suitable value (for example, the parameter value should be prime, but the user input a non-prime number, so Oracle adjusted the value to the next prime number).
isdeprecated:
type: string
description: Indicates whether the parameter has been deprecated (TRUE) or not (FALSE).
isbasic:
type: string
description: Indicates whether the parameter is a basic parameter (TRUE) or not (FALSE).
description:
type: string
description: Description of the parameter.
update_comment:
type: string
description: Comments associated with the most recent update.
hash:
type: integer
description: Hash value for the parameter name.
con_id:
type: integer
description: The ID of the container to which the data pertains.
links:
type: array
items:
$ref: '#/components/schemas/LinkRelation'
TransactionResponse:
type: object
properties:
gtrid:
type: string
status:
type: string
DatabaseTablespaceDatafiles:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/DatabaseTablespaceDatafilesItem'
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: '#/components/schemas/LinkRelation'
DatabaseConnections:
type: object
description: Information on the listeners configured for the database is retrieved from GV$LISTENER_NETWORK.
properties:
items:
type: array
items:
$ref: '#/components/schemas/DatabaseConnectionsItem'
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: '#/components/schemas/LinkRelation'
DatabaseTablespaceDatafileUsageItem:
type: object
description: Using GV$DATAFILE and DBA_FREE_SPACE data this object represents the usage of a data file in the database.
properties:
file_name:
type: string
description: Name of the database file.
file_id:
type: integer
description: File identifier number of the database file.
tablespace:
type: string
description: Name of the tablespace.
status:
type: string
description: File status.
total_space:
type: integer
description: Total size of the files (in bytes).
used_space:
type: integer
description: Total used space (in bytes).
used_space_pct:
type: number
description: :Percentage of how much space is used.
autoextend:
type: string
description: Indicates whether the file is autoextensible (YES) or not (NO).
links:
type: array
items:
$ref: '#/components/schemas/LinkRelation'
DatabaseStorageBytesItem:
type: object
description: Total size of data files in the database and their total usage.
properties:
total_bytes:
type: integer
description: Total size (in bytes) of all the data files in the database.
used_bytes:
type: integer
description: Total number of bytes used by all the tablespaces in the database.
links:
type: array
items:
$ref: '#/components/schemas/LinkRelation'
examples:
FilterCriteria:
summary: Implicit EQUALS operator for a number. Supports String and Dates too.
value:
SALARY: 1000
OrderByProperty:
summary: Order by with literals.
value:
$orderby:
SALARY: ASC
ENAME: DESC
FilterAndOrder:
summary: Filter criteria supports a wide range of operators. In this example LIKE operator ($like) is used. See Oracle REST Data Services production documentation 'Filtering in Queries' section for further information on the operators available.
value:
ENAME:
$like: AX%
$orderby:
ENAME: ASC
parameters:
Filter:
name: q
in: query
description: Filtering is the process of limiting a collection resource by using a per-request dynamic filter definition across multiple page resources, where each page contains a subset of items found in the complete collection. Filtering enables efficient traversal of large collections.
required: false
schema:
$ref: '#/components/schemas/Filter'
examples:
FilterCriteriaExample:
$ref: '#/components/examples/FilterCriteria'
OrderByPropertyExample:
$ref: '#/components/examples/OrderByProperty'
FilterAndOrderExample:
$ref: '#/components/examples/FilterAndOrder'
Limit:
name: limit
in: query
description: The maximum number of records to return.
required: false
schema:
type: integer
format: int32
securitySchemes:
BasicAuth:
type: http
scheme: basic
BearerAuth:
type: http
scheme: bearer
OAuth2:
type: oauth2
flows:
implicit:
authorizationUrl: /oauth/auth
scopes: {}
authorizationCode:
authorizationUrl: /oauth/auth
tokenUrl: /oauth/token
scopes: {}
clientCredentials:
tokenUrl: /oauth/token
scopes: {}
externalDocs:
description: Oracle REST Data Services product documentation.
url: https://docs.oracle.com/en/database/oracle/oracle-rest-data-services/