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 specific tablespace
- Method: getPath:
/database/tablespaces/{tablespace_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 all tablespaces
- Method: getPath:
/database/tablespaces/
- 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}
Data Pump
Services related to Oracle Data Pump. Oracle Data Pump technology enables very high-speed movement of data and metadata from one database to another. Functionality may differ depending on the configuration and permissions the database user has.
- Create an export data pump job
- Method: postPath:
/database/datapump/export
- Create an import data pump job
- Method: postPath:
/database/datapump/import
- 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 all data pump jobs
- Method: getPath:
/database/datapump/jobs/
Data Tools
Services related to loading, manipulating and analyzing data.
- Creates Cloud Storage Link
- Method: postPath:
/data-tools/cloud-storage-links/
- Creates credentials
- Method: postPath:
/data-tools/credentials/
- Creates data load jobs
- Method: postPath:
/data-tools/data-loads/
- Creates Live Table Feed
- Method: postPath:
/data-tools/live-table-feeds/
- Delete a Cloud Storage Link
- Method: deletePath:
/data-tools/cloud-storage-links/{owner},{storage_link_name}
- Delete a credential
- Method: deletePath:
/data-tools/credentials/{owner},{credential_name}
- Delete data load job
- Method: deletePath:
/data-tools/data-loads/{owner},{data_load_job_id}
- Delete Live Table Feed
- Method: deletePath:
/data-tools/live-table-feeds/{owner},{feed_name}
- Gets Cloud Storage Links
- Method: getPath:
/data-tools/cloud-storage-links/
- Gets credentials
- Method: getPath:
/data-tools/credentials/
- Gets data load jobs
- Method: getPath:
/data-tools/data-loads/
- Gets Live Table Feed notification key
- Method: getPath:
/data-tools/live-table-feeds/{owner},{feed_name}/key
- Gets Live Table Feeds
- Method: getPath:
/data-tools/live-table-feeds/
- Gets progress of data load job
- Method: getPath:
/data-tools/data-loads/{owner},{data_load_job_id}/progress
- Gets specific Cloud Storage Link
- Method: getPath:
/data-tools/cloud-storage-links/{owner},{storage_link_name}
- Gets specific credential
- Method: getPath:
/data-tools/credentials/{owner},{credential_name}
- Gets specific data load job
- Method: getPath:
/data-tools/data-loads/{owner},{data_load_job_id}
- Gets specific Live Table Feed
- Method: getPath:
/data-tools/live-table-feeds/{owner},{feed_name}
- Modify Live Table Feed
- Method: putPath:
/data-tools/live-table-feeds/{owner},{feed_name}
- Surveys input data
- Method: postPath:
/data-tools/surveys/
- Triggers data load for Live Table Feed
- Method: postPath:
/data-tools/live-table-feeds/{owner},{feed_name}/load_new_data
Environment
Services related to the Oracle database installation. The implementation is only available for Unix based operating systems.
- 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/
- 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 specific database parameter
- Method: getPath:
/database/parameters/{name}
- Get a specific database user
- Method: getPath:
/database/security/users/{username}
- Get a tablespace segment
- Method: getPath:
/database/storage/tablespaces/{tablespace_name}/segments/{segment_name}
- 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 storage data
- 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 for a specific tablespace
- Method: getPath:
/database/storage/tablespaces/{tablespace_name}/
- 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
ORDS REST Services
Custom Oracle REST Data Services built with SQL & PL/SQL.
- Create a REST handler parameter
- Method: postPath:
/ords/rest/parameters/
- Create a REST module
- Method: postPath:
/ords/rest/modules/
- Create a REST module template
- Method: postPath:
/ords/rest/templates/
- Create a REST template handler
- Method: postPath:
/ords/rest/handlers/
- Create an ORDS OAuth client
- Method: postPath:
/ords/rest/clients/
- Create an ORDS privilege
- Method: postPath:
/ords/rest/privileges/
- Create an ORDS role
- Method: postPath:
/ords/rest/roles/
- Delete a REST handler parameter
- Method: deletePath:
/ords/rest/parameters/{id}
- Delete a REST module template
- Method: deletePath:
/ords/rest/templates/{id}
- Delete a REST template handler
- Method: deletePath:
/ords/rest/handlers/{id}
- Delete an ORDS OAuth client
- Method: deletePath:
/ords/rest/clients/{id}
- Delete an ORDS privilege
- Method: deletePath:
/ords/rest/privileges/{id}
- Delete an ORDS role
- Method: deletePath:
/ords/rest/roles/{id}
- Get a REST enabled object
- Method: getPath:
/ords/rest/autorest/{id}
- Get a REST enabled object metadata
- Method: getPath:
/ords/rest/autorest/{id}/metadata
- Get a REST handler parameter
- Method: getPath:
/ords/rest/parameters/{id}
- Get a REST handler source
- Method: getPath:
/ords/rest/handlers/{id}/source
- Get a REST module
- Method: getPath:
/ords/rest/modules/{id}
- Get a REST module source
- Method: getPath:
/ords/rest/modules/{id}/source
- Get a REST module template
- Method: getPath:
/ords/rest/templates/{id}
- Get a REST template handler
- Method: getPath:
/ords/rest/handlers/{id}
- Get all current schema recent REST objects
- Method: getPath:
/ords/rest/overview/objects_recent
- Get all ORDS OAuth clients
- Method: getPath:
/ords/rest/clients/
- Get all ORDS privileges
- Method: getPath:
/ords/rest/privileges/
- Get all ORDS privileges for a specific role
- Method: getPath:
/ords/rest/roles/{id}/privileges/
- Get all ORDS privileges in an OAuth client
- Method: getPath:
/ords/rest/clients/{id}/privileges/
- Get all ORDS properties values
- Method: getPath:
/ords/properties/
- Get all ORDS roles
- Method: getPath:
/ords/rest/roles/
- Get all ORDS roles in a privilege
- Method: getPath:
/ords/rest/privileges/{id}/roles/
- Get all ORDS roles in an OAuth client
- Method: getPath:
/ords/rest/clients/{id}/roles/
- Get all protected REST modules
- Method: getPath:
/ords/rest/privilege/modules/
- Get all REST enabled objects
- Method: getPath:
/ords/rest/autorest/
- Get all REST handler parameters
- Method: getPath:
/ords/rest/parameters/
- Get all REST module templates
- Method: getPath:
/ords/rest/templates/
- Get all REST modules
- Method: getPath:
/ords/rest/modules/
- Get all REST modules in a privilege
- Method: getPath:
/ords/rest/privileges/{id}/modules/
- Get all REST patterns in a privilege
- Method: getPath:
/ords/rest/privileges/{id}/patterns/
- Get all REST template handlers
- Method: getPath:
/ords/rest/handlers/
- Get an ORDS OAuth client
- Method: getPath:
/ords/rest/clients/{id}
- Get an ORDS privilege
- Method: getPath:
/ords/rest/privileges/{id}
- Get an ORDS property value
- Method: getPath:
/ords/properties/{key}
- Get an ORDS property value for a schema
- Method: getPath:
/ords/properties/{schema}/{key}
- Get an ORDS role
- Method: getPath:
/ords/rest/roles/{id}
- Get count of all the REST enabled objects
- Method: getPath:
/ords/rest/autorest/summary
- Get current ORDS schema and count of all current schema REST objects and count of all REST modules
- Method: getPath:
/ords/rest/overview/
- REST enable an object
- Method: postPath:
/ords/rest/autorest/
- Set an ORDS property value
- Method: putPath:
/ords/properties/{key}
- Set an ORDS property value for a schema
- Method: putPath:
/ords/properties/{schema}/{key}
- Unset an ORDS property value
- Method: deletePath:
/ords/properties/{key}
- Unset an ORDS property value for a schema
- Method: deletePath:
/ords/properties/{schema}/{key}
- Update a REST handler parameter
- Method: putPath:
/ords/rest/parameters/{id}
- Update a REST module
- Method: putPath:
/ords/rest/modules/{id}
- Update a REST module template
- Method: putPath:
/ords/rest/templates/{id}
- Update a REST template handler
- Method: putPath:
/ords/rest/handlers/{id}
- Update an ORDS OAuth client
- Method: putPath:
/ords/rest/clients/{id}
- Update an ORDS privilege
- Method: putPath:
/ords/rest/privileges/{id}
- Update an ORDS role
- Method: putPath:
/ords/rest/roles/{id}
- Update or disables a REST enabled object
- Method: putPath:
/ords/rest/autorest/{id}
- Updates the ORDS OAuth client avatar image.
- Method: postPath:
/ords/rest/clients/{id}/logo/
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.
- Create or Update an APEX application, with a specific application id, in the specified workspace
- Method: putPath:
/apex/workspaces/{workspace_name}/applications/{application_id}
- Delete the specified APEX application
- Method: deletePath:
/apex/workspaces/{workspace_name}/applications/{application_id}
- Export APEX application components
- Method: postPath:
/apex/applications/{application_id}
- Get all applications in the specified workspace
- Method: getPath:
/apex/workspaces/{workspace_name}/applications/
- 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/
- Get or export a specific APEX application
- Method: getPath:
/apex/applications/{application_id}
- Get workspace
- Method: getPath:
/apex/workspaces/{workspace_name}/
Oracle Transactional Event Queues
Services related to Oracle Transactional Event Queues.
- Create a Consumer Group
- Method: postPath:
/database/txeventq/clusters/{cluster_id}/consumer-groups/{consumer_group_id}
- Create a new Transactional Event Queue Topic
- Method: postPath:
/database/txeventq/clusters/{cluster_id}/topics
- Create Consumer Instance
- Method: postPath:
/database/txeventq/consumers/{group_name}
- Delete a Consumer Group
- Method: deletePath:
/database/txeventq/clusters/{cluster_id}/consumer-groups/{consumer_group_id}
- Delete Consumer Instance
- Method: deletePath:
/database/txeventq/consumers/{group_name}/instances/{instance}
- Delete the Transactional Event Queue Topic with the specified topic_name
- Method: deletePath:
/database/txeventq/clusters/{cluster_id}/topics/{topic_name}
- Describe the specified Transactional Event Queue Topic Partition
- Method: getPath:
/database/txeventq/topics/{topic_name}/partitions/{partition_id}
- Describe Transactional Event Queue Topic Partition specified in Cluster
- Method: getPath:
/database/txeventq/clusters/{cluster_id}/topics/{topic_name}/partitions/{partition_id}
- Describe Transactional Event Queue Topic Partitions
- Method: getPath:
/database/txeventq/topics/{topic_name}/partitions
- Describes Transactional Event Queue Topic in Cluster
- Method: getPath:
/database/txeventq/clusters/{cluster_id}/topics/{topic_name}
- Fetch messages for the specified Consumer
- Method: getPath:
/database/txeventq/consumers/{group_name}/instances/{instance}/records
- Get a Consumer Group
- Method: getPath:
/database/txeventq/clusters/{cluster_id}/consumer-groups/{consumer_group_id}
- Get all Transactional Event Queue Topics in the schema
- Method: getPath:
/database/txeventq/topics
- Get Consumer Groups in Cluster
- Method: getPath:
/database/txeventq/clusters/{cluster_id}/consumer-groups
- Get consumer lag for Transactional Event Queue Topic Partition
- Method: getPath:
/database/txeventq/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lags/{topic_name}/partitions/{partition_id}
- Get Consumer last Commit Offsets
- Method: getPath:
/database/txeventq/consumers/{group_name}/instances/{instance}/offsets
- Get description of a particular Transactional Event Queue Topic.
- Method: getPath:
/database/txeventq/topics/{topic_name}
- Get lag summary for Consumer Groups in Cluster
- Method: getPath:
/database/txeventq/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lag-summary
- Get Transactional Event Queue Topic Partition Offsets
- Method: getPath:
/database/txeventq/topics/{topic_name}/partitions/{partition_id}/offsets
- Lags/Offsets of consumers in the Consumer group
- Method: getPath:
/database/txeventq/clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lags
- List Partitions for a Transactional Event Queue Topic in Cluster
- Method: getPath:
/database/txeventq/clusters/{cluster_id}/topics/{topic_name}/partitions
- List Transactional Event Queue Topics that belong to the specified database cluster
- Method: getPath:
/database/txeventq/clusters/{cluster_id}/topics
- Produce a message to the Transactional Event Queue Topic specified by topic_name
- Method: postPath:
/database/txeventq/topics/{topic_name}
- Produce messages in the specified Transactional Event Queue Topic Partition
- Method: postPath:
/database/txeventq/topics/{topic_name}/partitions/{partition_id}
- Seek to End of Partitions for Consumer Group
- Method: postPath:
/database/txeventq/consumers/{group_name}/instances/{instance}/positions/end
- Seek to specified Transactional Event Queue Topic partition offsets for Consumer Group
- Method: postPath:
/database/txeventq/consumers/{group_name}/instances/{instance}/positions
- Seek to start of Partitions for Consumer Group
- Method: postPath:
/database/txeventq/consumers/{group_name}/instances/{instance}/positions/beginning
- Subscribed list of Transactional Event Queue Topics
- Method: getPath:
/database/txeventq/consumers/{group_name}/instances/{instance}/subscription
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.
- Create a Pluggable Database
- 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/
- The list of all snapshots taken for the specified pluggable databases (PDBs)
- Method: getPath:
/database/pdb_snapshots/{pdb_name}/
- The snapshots of all pluggable databases (PDBs) in the Container Database
- Method: getPath:
/database/pdb_snapshots/
- The specific snapshot taken of the specific pluggable databases (PDBs)
- Method: getPath:
/database/pdb_snapshots/{pdb_name}/{snapshot_name}
- Update a specific PDB
- Method: patchPath:
/database/pdbs/{pdb_name}
Pluggable Database Snapshot Carousel
Services related to managing pluggable databases snapshots in an Oracle database instance.
- Configure automatic PDB snapshots.
- Method: putPath:
/database/snapshots/
- Create snapshot of the current pluggable databases, the name will be generated
- Method: postPath:
/database/snapshots/
- Create snapshot of the current pluggable databases, the name will be {snapshotName}
- Method: postPath:
/database/snapshots/{snapshot_name}
- Delete the specified snapshot
- Method: deletePath:
/database/snapshots/{snapshot_name}
- get all snapshots of the current pluggable databases
- Method: getPath:
/database/snapshots/
- Get snapshot mode in current PDB
- Method: getPath:
/database/snapshot_mode
- Get specific snapshot based on the name in current PDB
- Method: getPath:
/database/snapshots/{snapshot_name}
RDF Graph
Services related to Oracle RDF Graph. Oracle RDF Graph provides functionality to manage knowledge graphs based on World Wide Web Consortium (W3C) standards such as RDF, OWL and SPARQL.
- Append a graph
- Method: postPath:
/database/rdf/networks/{network_owner},{network_name}/models/{model_name}/graph_store/1.1
- Create entailment
- Method: putPath:
/database/rdf/networks/{network_owner},{network_name}/entailments/{entailment_name}
- Create RDF model
- Method: putPath:
/database/rdf/networks/{network_owner},{network_name}/models/{model_name}
- Create RDF network
- Method: putPath:
/database/rdf/networks/{network_owner},{network_name}
- Create virtual model
- Method: putPath:
/database/rdf/networks/{network_owner},{network_name}/virtual_models/{virtual_model_name}
- Delete a graph
- Method: deletePath:
/database/rdf/networks/{network_owner},{network_name}/models/{model_name}/graph_store/1.1
- Drop entailment
- Method: deletePath:
/database/rdf/networks/{network_owner},{network_name}/entailments/{entailment_name}
- Drop RDF model
- Method: deletePath:
/database/rdf/networks/{network_owner},{network_name}/models/{model_name}
- Drop RDF network
- Method: deletePath:
/database/rdf/networks/{network_owner},{network_name}
- Drop virtual model
- Method: deletePath:
/database/rdf/networks/{network_owner},{network_name}/virtual_models/{virtual_model_name}
- Entailment information
- Method: getPath:
/database/rdf/networks/{network_owner},{network_name}/entailments/{entailment_name}
- Execute a SPARQL query
- Method: getPath:
/database/rdf/networks/{network_owner},{network_name}/models/{model_name}/sparql/1.1
- Execute a SPARQL query or update
- Method: postPath:
/database/rdf/networks/{network_owner},{network_name}/models/{model_name}/sparql/1.1
- Get a graph
- Method: getPath:
/database/rdf/networks/{network_owner},{network_name}/models/{model_name}/graph_store/1.1
- List entailments
- Method: getPath:
/database/rdf/networks/{network_owner},{network_name}/entailments/
- List RDF models
- Method: getPath:
/database/rdf/networks/{network_owner},{network_name}/models/
- List RDF networks
- Method: getPath:
/database/rdf/networks/
- List virtual models
- Method: getPath:
/database/rdf/networks/{network_owner},{network_name}/virtual_models/
- RDF model information
- Method: getPath:
/database/rdf/networks/{network_owner},{network_name}/models/{model_name}
- RDF network information
- Method: getPath:
/database/rdf/networks/{network_owner},{network_name}
- Replace a graph
- Method: putPath:
/database/rdf/networks/{network_owner},{network_name}/models/{model_name}/graph_store/1.1
- Translate SPARQL to SQL
- Method: getPath:
/database/rdf/networks/{network_owner},{network_name}/models/{model_name}/sparql2sql/1.1
- Translate SPARQL to SQL
- Method: postPath:
/database/rdf/networks/{network_owner},{network_name}/models/{model_name}/sparql2sql/1.1
- Virtual model information
- Method: getPath:
/database/rdf/networks/{network_owner},{network_name}/virtual_models/{virtual_model_name}
Scheduler
Oracle Scheduler, an enterprise job scheduler to help you simplify the scheduling of hundreds or even thousands of tasks. Oracle Scheduler (the Scheduler) is implemented by the procedures and functions in the DBMS_SCHEDULER PL/SQL package.
- Get a specific Oracle Scheduler job
- Method: getPath:
/database/scheduler/jobs/{owner},{job_name}
- Get all Oracle Scheduler jobs
- Method: getPath:
/database/scheduler/jobs/