All REST Endpoints
Data Dictionary
Services related to the tables and views that provide information about the database.
- Get a database link
- Method: getPath:
/database/db_links/{owner},{db_link}
- Get a partition
- Method: getPath:
/database/objects/partitions/{table_owner},{table_name},{partition_name}
- Get a procedure that is defined in package
- Method: getPath:
/database/objects/packages/procedures/{object_id},{subprogram_id}
- Get a specific column
- Method: getPath:
/database/objects/columns/{owner},{table_name},{column_name}
- Get a specific foreign keys
- Method: getPath:
/database/objects/foreign_keys/{owner},{constraint_name}
- Get a specific function
- Method: getPath:
/database/objects/functions/{object_id}
- Get a specific index
- Method: getPath:
/database/objects/indexes/{owner},{index_name}
- Get a specific object
- Method: getPath:
/database/objects/{owner},{object_name},{object_type}
- Get a specific table
- Method: getPath:
/database/objects/tables/{owner},{table_name}
- Get a synonym
- Method: getPath:
/database/objects/synonyms/{owner},{synonym_name}
- Get all arguments for functions and procedures
- Method: getPath:
/database/objects/arguments/
- Get all database links
- Method: getPath:
/database/db_links/
- Get all database objects
- Method: getPath:
/database/objects/
- Get all foreign keys
- Method: getPath:
/database/objects/foreign_keys/
- Get all functions
- Method: getPath:
/database/objects/functions/
- Get all indexes
- Method: getPath:
/database/objects/indexes/
- Get all materialized view logs
- Method: getPath:
/database/objects/materialized_view_logs/
- Get all object types
- Method: getPath:
/database/objects/types/
- Get all partitions in the database
- Method: getPath:
/database/objects/partitions/
- Get all procedures defined in package
- Method: getPath:
/database/objects/packages/procedures/
- Get all synonyms in the database
- Method: getPath:
/database/objects/synonyms/
- Get all table columns
- Method: getPath:
/database/objects/columns/
- Get all tables
- Method: getPath:
/database/objects/tables/
- Get an argument
- Method: getPath:
/database/objects/arguments/{object_id},{subprogram_id},{argument_name}
- Get an object type
- Method: getPath:
/database/objects/types/{owner},{type_name}
- Get information on a specific materialized view log
- Method: getPath:
/database/objects/materialized_view_logs/{log_owner},{log_table}
Data Guard
Services related to Oracle Data Guard. The product must be installed in the Oracle database that ORDS is configured to use.
- Add a configuration
- Method: postPath:
/database/dataguard/configuration/
- Add a database
- Method: postPath:
/database/dataguard/databases/
- Alter a configuration property
- Method: putPath:
/database/dataguard/configuration/properties/{property}
- Convert, enable, disable, or set the role of a database
- Method: putPath:
/database/dataguard/databases/{database}
- Delete the current database from the broker
- Method: deletePath:
/database/dataguard/databases/{database}
- Delete the Data Guard instance
- Method: deletePath:
/database/dataguard/databases/{database}/instances/{instance}
- Enable or disable a configuration
- Method: putPath:
/database/dataguard/configuration/
- Get a database Data Guard property
- Method: getPath:
/database/dataguard/databases/{database}/properties/{property}
- Get the current broker configuration
- Method: getPath:
/database/dataguard/configuration/
- Get the current broker configuration database
- Method: getPath:
/database/dataguard/databases/{database}
- Get the current broker configuration databases
- Method: getPath:
/database/dataguard/databases/
- Get the current broker configuration properties
- Method: getPath:
/database/dataguard/configuration/properties/
- Get the current broker database instances information
- Method: getPath:
/database/dataguard/databases/{database}/instances/
- Get the database Data Guard properties
- Method: getPath:
/database/dataguard/databases/{database}/properties/
- Get the specified broker configuration property
- Method: getPath:
/database/dataguard/configuration/properties/{property}
- Remove the configuration
- Method: deletePath:
/database/dataguard/configuration/
- Set the value of a database Data Guard property
- Method: putPath:
/database/dataguard/databases/{database}/properties/{property}
Environment
Services related to the Oracle database installation.
- Create a new database in the default Oracle Home
- Method: postPath:
/environment/databases/
- Create a new database in the specified Oracle Home
- Method: postPath:
/environment/homes/{homeName}/databases/
- Create a new DBCA job in the default Oracle Home
- Method: postPath:
/environment/dbca/jobs/
- Create a new DBCA job in the Oracle Home
- Method: postPath:
/environment/homes/{homeName}/dbca/jobs/
- Delete the specified DBCA job in the default Oracle Home
- Method: deletePath:
/environment/dbca/jobs/{jobId}/
- Delete the specified DBCA job in the default Oracle Home
- Method: deletePath:
/environment/homes/{homeName}/dbca/jobs/{jobId}/
- Get a list of the databases defined in an Oracle Home
- Method: getPath:
/environment/homes/{homeName}/databases/
- Get a list of the databases defined in the default Oracle Home
- Method: getPath:
/environment/databases/
- Get a list of the DBCA database templates defined in an Oracle Home
- Method: getPath:
/environment/homes/{homeName}/dbca/templates/
- Get a list of the DBCA database templates defined in the default Oracle Home
- Method: getPath:
/environment/dbca/templates/
- Get a list of the DBCA jobs created through ORDS Database API in the default Oracle Home
- Method: getPath:
/environment/dbca/jobs/
- Get a list of the DBCA jobs created through ORDS Database API in the Oracle Home
- Method: getPath:
/environment/homes/{homeName}/dbca/jobs/
- Get a specific database defined in a specific Oracle Home
- Method: getPath:
/environment/homes/{homeName}/databases/{databaseName}
- Get a specific database defined in the default Oracle Home
- Method: getPath:
/environment/databases/{databaseName}
- Get a specific database template file in a specific Oracle Home
- Method: getPath:
/environment/homes/{homeName}/dbca/templates/{filename}
- Get a specific database template file in the default Oracle Home
- Method: getPath:
/environment/dbca/templates/{filename}
- Get a specified DBCA jobs created through ORDS Database API in the default Oracle Home
- Method: getPath:
/environment/dbca/jobs/{jobId}/
- Get a specified DBCA jobs created through ORDS Database API in the specified Oracle Home
- Method: getPath:
/environment/homes/{homeName}/dbca/jobs/{jobId}/
- Get database Oracle Homes
- Method: getPath:
/environment/homes/
- Get the DBCA log file content for a specified DBCA jobs created through ORDS Database API in the default Oracle Home
- Method: getPath:
/environment/dbca/jobs/{jobId}/log
- Get the DBCA log file content for a specified DBCA jobs created through ORDS Database API in the specified Oracle Home
- Method: getPath:
/environment/homes/{homeName}/dbca/jobs/{jobId}/log
General
Services related to the Oracle database instance.
- Create a data pump job
- Method: postPath:
/database/datapump/jobs/
- Create an export data pump job
- Method: postPath:
/database/datapump/export
- Create an import data pump job
- Method: postPath:
/database/datapump/import
- Get a database component
- Method: getPath:
/database/components/{comp_id}
- Get a description of a specific local listener for this database
- Method: getPath:
/database/connections/{host_name},{port},{service_name}
- Get a description of all local listeners for this database
- Method: getPath:
/database/connections/
- Get a file for a specific data pump job
- Method: getPath:
/database/datapump/jobs/{owner_name},{job_name}/{filename}
- Get a specific data pump job
- Method: getPath:
/database/datapump/jobs/{owner_name},{job_name}/
- Get a specific database parameter
- Method: getPath:
/database/parameters/{name}
- Get a specific database user
- Method: getPath:
/database/security/users/{username}
- Get a tablespace
- Method: getPath:
/database/storage/tablespaces/{tablespace_name}/
- Get a tablespace segment
- Method: getPath:
/database/storage/tablespaces/{tablespace_name}/segments/{segment_name}
- Get all data pump jobs
- Method: getPath:
/database/datapump/jobs/
- Get all database components
- Method: getPath:
/database/components/
- Get all database parameters
- Method: getPath:
/database/parameters/
- Get all database users
- Method: getPath:
/database/security/users/
- Get all feature usage statistics
- Method: getPath:
/database/feature_usage/
- Get all tablespaces
- Method: getPath:
/database/storage/tablespaces/
- Get data file usage summary for a specific tablespace
- Method: getPath:
/database/storage/tablespaces/{tablespace_name}/datafiles_usage
- Get data files for a tablespace
- Method: getPath:
/database/storage/tablespaces/{tablespace_name}/datafiles/
- Get database status
- Method: getPath:
/database/status
- Get database version
- Method: getPath:
/database/version
- Get specific database Oracle Home
- Method: getPath:
/environment/homes/{homeName}/
- Get storage statistics
- Method: getPath:
/database/storage/bytes
- Get tablespace data file
- Method: getPath:
/database/storage/tablespaces/{tablespace_name}/datafiles/{file_id}/
- Get tablespace data file usage
- Method: getPath:
/database/storage/tablespaces/{tablespace_name}/datafiles/{file_id}/usage
- Get tablespace segments
- Method: getPath:
/database/storage/tablespaces/{tablespace_name}/segments/
- Get tablespace space usage history
- Method: getPath:
/database/storage/tablespaces/{tablespace_name}/history
- Get tablespace temporary file
- Method: getPath:
/database/storage/tablespaces/{tablespace_name}/tempfiles/{file_id}/
- Get tablespace temporary file usage
- Method: getPath:
/database/storage/tablespaces/{tablespace_name}/tempfiles/{file_id}/usage
- Get temporary file usage summary for a specific tablespace
- Method: getPath:
/database/storage/tablespaces/{tablespace_name}/tempfiles_usage
- Get temporary files for a tablespace
- Method: getPath:
/database/storage/tablespaces/{tablespace_name}/tempfiles/
- Get usage statistic for a feature
- Method: getPath:
/database/feature_usage/{dbid},{name}
Monitoring
Services related to monitoring the Oracle database instance.
- Get a session
- Method: getPath:
/database/monitoring/sessions/{sid},{serial_number}/
- Get a session lock that is blocking other sessions
- Method: getPath:
/database/monitoring/session_locks/holding/{session_id},{lock_id1},{lock_id2}
- Get a specific lock that a session is waiting on
- Method: getPath:
/database/monitoring/session_locks/waiting/{session_id},{lock_id1},{lock_id2}
- Get a specific session lock record
- Method: getPath:
/database/monitoring/session_locks/{session_id},{lock_id1},{lock_id2}
- Get a specific session wait
- Method: getPath:
/database/monitoring/session_waits/{sid},{seq_number}
- Get a specific session wait class record
- Method: getPath:
/database/monitoring/session_wait_classes/{sid},{serial_number},{wait_class_number}
- Get all alerts
- Method: getPath:
/database/monitoring/alerts/
- Get all current sessions
- Method: getPath:
/database/monitoring/sessions/
- Get all locks held in the database
- Method: getPath:
/database/monitoring/session_locks/
- Get all locks that are blocking other sessions
- Method: getPath:
/database/monitoring/session_locks/holding/
- Get all locks that sessions are waiting on
- Method: getPath:
/database/monitoring/session_locks/waiting/
- Get all long running operations for a session
- Method: getPath:
/database/monitoring/sessions/{sid},{serial_number}/long_running_operations
- Get all session limits
- Method: getPath:
/database/monitoring/session_limits
- Get all session wait class records
- Method: getPath:
/database/monitoring/session_wait_classes/
- Get all session waits
- Method: getPath:
/database/monitoring/session_waits/
- Get all wait class metrics
- Method: getPath:
/database/monitoring/wait_class_metrics
- Get an alert record
- Method: getPath:
/database/monitoring/alerts/{record_id}
- Get count of alerts by message level
- Method: getPath:
/database/monitoring/alerts_summaries/by_message_level
- Get count of alerts by message type
- Method: getPath:
/database/monitoring/alerts_summaries/by_message_type
- Get count of different session types
- Method: getPath:
/database/monitoring/session_summaries/by_type
- Get count of recent alerts by message level
- Method: getPath:
/database/monitoring/alerts_recent_summaries/by_message_level
- Get count of recent alerts by message type
- Method: getPath:
/database/monitoring/alerts_recent_summaries/by_message_type
- Get current active process for a session
- Method: getPath:
/database/monitoring/sessions/{sid},{serial_number}/process
- Get time totals for all registered wait classes
- Method: getPath:
/database/monitoring/wait_class_totals
- Get wait time summary from recent active session history records
- Method: getPath:
/database/monitoring/waits_recent
Open Service Broker
Services related to the Open Service Broker compliant implementation that ORDS provides.
- Deprovision a service instance
- Method: deletePath:
/openservicebroker/v2/service_instances/{instance_id}
- Get the catalog of services that the service broker offers
- Method: getPath:
/openservicebroker/v2/catalog
- Provision a service instance
- Method: putPath:
/openservicebroker/v2/service_instances/{instance_id}
Oracle APEX
Services related to Oracle APEX. The product must be installed in the Oracle database that ORDS is configured to use.
- Get all workspaces
- Method: getPath:
/apex/workspaces/
- Get application statistics
- Method: getPath:
/apex/statistics/application/{application_id}/
- Get application statistics
- Method: getPath:
/apex/statistics/workspace/{workspace_name}/
- Get instance overview
- Method: getPath:
/apex/statistics/overview
- Get instance statistics
- Method: getPath:
/apex/statistics/instance/
Performance
Services related to the runtime performance of the Oracle database instance.
- Get a specified sampled session activity in the database
- Method: getPath:
/database/performance/active_sessions_history/{sample_id},{session_id}
- Get all sampled session activity in the database
- Method: getPath:
/database/performance/active_sessions_history/
- Get all SQL statements ordered by CPU time descending
- Method: getPath:
/database/performance/top_sql_statements/
- Get execution plan for an SQL Statement
- Method: getPath:
/database/performance/sql_statements/{sql_id}/plan
- Get historical statistics for a SQL statement
- Method: getPath:
/database/performance/sql_statements/{sql_id}/history
- Get information on a monitored statement
- Method: getPath:
/database/performance/sql_statements/{sql_id}/monitor/{sql_exec_id},{sql_exec_start}/
- Get monitoring statistics for a SQL Statement
- Method: getPath:
/database/performance/sql_statements/{sql_id}/monitor/
- Get parallel execution information for specific statement execution
- Method: getPath:
/database/performance/sql_statements/{sql_id}/monitor/{sql_exec_id},{sql_exec_start}/parallelism
- Get SQL statement
- Method: getPath:
/database/performance/sql_statements/{sql_id}/text
- Get SQL statistics for a specific session
- Method: getPath:
/database/performance/active_sessions_history_waits/{sid},{seq_number}/active_sql
- Get SQL statistics maximum values
- Method: getPath:
/database/performance/top_sql_statements/maximums
- Get statistics for a SQL statement
- Method: getPath:
/database/performance/sql_statements/{sql_id}/
- Get statistics for all SQL statements
- Method: getPath:
/database/performance/sql_statements/
- Get the last 10 wait events for each active session
- Method: getPath:
/database/performance/active_sessions_history_waits/
- Get the specified wait event for specific active session
- Method: getPath:
/database/performance/active_sessions_history_waits/{sid},{seq_number}/
Pluggable Database Lifecycle Management
Services related to managing pluggable databases in an Oracle multitenant database instance.
- Change the state of a PDB
- Method: postPath:
/database/pdbs/{pdb_name}/status
- Clone or Unplug operations for PDBs
- Method: postPath:
/database/pdbs/{pdb_name}/
- Create a PDB from PDB$SEED or XML
- Method: postPath:
/database/pdbs/
- Drop a PDB
- Method: deletePath:
/database/pdbs/{pdb_name}/
- Get a pluggable database
- Method: getPath:
/database/pdbs/{pdb_name}/
- Get all pluggable databases
- Method: getPath:
/database/pdbs/
- Return status information of a PDB
- Method: getPath:
/database/pdbs/{pdb_name}/status