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 Scheduler 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: Scheduler
description: 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.
paths:
/database/scheduler/jobs/:
get:
tags:
- Scheduler
summary: Get all Oracle Scheduler jobs
description: Returns records from DBA_SCHEDULER_JOBS or ALL_SCHEDULER_JOBS view depending on the role at runtime. This service requires db.cdb.adminUser credentials to be set in the pool configuration. 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 jobs in the database.
content:
application/json:
schema:
$ref: '#/components/schemas/SchedulerJobs'
x-internal-id: database-scheduler-jobs--get
x-filename-id: database-scheduler-jobs-get
/database/scheduler/jobs/{owner},{job_name}:
get:
tags:
- Scheduler
summary: Get a specific Oracle Scheduler job
description: Returns specific record from DBA_SCHEDULER_JOBS or ALL_SCHEDULER_JOBS view depending on the role at runtime. This service requires db.cdb.adminUser credentials to be set in the pool configuration. A client requires SQL Administrator or SQL Developer role to invoke this service.
parameters:
- name: owner
in: path
description: Owner of the job.
required: true
schema:
type: string
- name: job_name
in: path
description: Name of the job.
required: true
schema:
type: string
responses:
'200':
description: Information on the specific scheduler job in the database.
content:
application/json:
schema:
$ref: '#/components/schemas/SchedulerJobsItem'
x-internal-id: database-scheduler-jobs-{owner},{job_name}-get
x-filename-id: database-scheduler-jobs-owner-job_name-get
components:
schemas:
SchedulerJobs:
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/SchedulerJobsItem'
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'
LinkRelation:
type: object
properties:
rel:
type: string
href:
type: string
required:
- rel
- href
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
SchedulerJobsItem:
description: Represents a row in ALL_SCHEDULER_JOBS or DBA_SCHEDULER_JOBS views. See Oracle Database Reference documenation for more details.
type: object
properties:
owner:
type: string
description: Owner of the Scheduler job.
job_name:
type: string
description: Name of the Scheduler job.
job_subname:
type: string
description: Subname of the Scheduler job (for a job running a chain step).
job_style:
type: string
description: 'Job style: REGULAR, LIGHTWEIGHT, IN_MEMORY_RUNTIME, IN_MEMORY_FULL.'
job_creator:
type: string
description: Original creator of the job.
client_id:
type: string
description: Client identifier of the user creating the job.
global_uid:
type: string
description: Global user identifier of the user creating the job.
program_owner:
type: string
description: Owner of the program associated with the job.
program_name:
type: string
description: Name of the program associated with the job.
job_type:
type: string
description: Inline job action type.
schedule_owner:
type: string
description: Owner of the schedule that the job uses (can be a window or a window group)
schedule_name:
type: string
description: Name of the schedule that the job uses (can be a window or a window group)
schedule_type:
type: string
description: Type of the schedule that the job uses.
start_date:
type: string
description: Original scheduled start date of the job (for an inline schedule).
repeat_interval:
type: string
description: Inline schedule PL/SQL expression or calendar string.
event_queue_owner:
type: string
description: Owner of the source queue into which the event will be raised.
event_queue_name:
type: string
description: Name of the source queue into which the event will be raised.
event_queue_agent:
type: string
description: Name of the AQ agent used by the user on the event source queue (if it is a secure queue).
event_condition:
type: string
description: Boolean expression used as the subscription rule for the event on the source queue.
event_rule:
type: string
description: Name of the rule used by the coordinator to trigger the event-based job.
file_watcher_owner:
type: string
description: Owner of the file watcher on which this job is based.
file_watcher_name:
type: string
description: Name of the file watcher on which this job is based.
end_date:
type: string
description: Date after which the job will no longer run (for an inline schedule).
job_class:
type: string
description: Name of the job class associated with the job.
enabled:
type: string
description: Indicates whether the job is enabled (TRUE) or disabled (FALSE).
auto_drop:
type: string
description: Indicates whether the job will be dropped when it has completed (TRUE) or not (FALSE).
restart_on_recovery:
type: string
description: Indicates whether the step should be restarted on database recovery (TRUE) or not (FALSE).
restart_on_failure:
type: string
description: Indicates whether the step should be restarted on application failure (TRUE) or not (FALSE).
state:
type: string
description: Current state of the job.
job_priority:
type: integer
description: Priority of the job relative to other jobs in the same class.
run_count:
type: integer
description: Number of times the job has run.
uptime_run_count:
type: integer
description: Number of runs since the database last restarted. For in-memory jobs, this column is populated, but the RUN_COUNT column is not populated. For all other jobs, this column is NULL.
max_runs:
type: integer
description: Maximum number of times the job is scheduled to run.
failure_count:
type: integer
description: Number of times the job has failed to run.
uptime_failure_count:
type: integer
description: Number of failures since the database last restarted. For in-memory jobs, this column is populated, but the FAILURE_COUNT column is not populated. For all other jobs, this column is NULL.
max_failures:
type: integer
description: Number of times the job will be allowed to fail before being marked broken.
retry_count:
type: integer
description: Number of times the job has retried, if it is retrying.
last_start_date:
type: string
description: Last date on which the job started running.
last_run_duration:
type: string
description: Amount of time the job took to complete during the last run.
next_run_date:
type: string
description: Next date on which the job is scheduled to run.
schedule_limit:
type: string
description: Time after which a job which has not run yet will be rescheduled.
max_run_duration:
type: string
description: Maximum amount of time for which the job will be allowed to run.
logging_level:
type: string
description: Amount of logging that will be done pertaining to the job.
store_output:
type: string
description: Indicates whether all job output messages for the job are stored in the OUTPUT column of the *_JOB_RUN_DETAILS views for job runs that are logged.
stop_on_window_close:
type: string
description: Indicates whether the job will stop if a window associated with the job closes (TRUE) or not (FALSE).
instance_stickiness:
type: string
description: Indicates whether the job is sticky (TRUE) or not (FALSE).
raise_events:
type: string
description: List of job events to raise for the job.
system:
type: string
description: Indicates whether the job is a system job (TRUE) or not (FALSE).
job_weight:
type: integer
description: Weight of the job.
nls_env:
type: string
description: NLS environment of the job.
source:
type: string
description: Source global database identifier.
number_of_destinations:
type: integer
description: Number of destinations associated with this job.
destination_owner:
type: string
description: Owner of the destination object (if used), else NULL.
destination:
type: string
description: Destination that this job will run on.
credential_owner:
type: string
description: Owner of the credential to be used for an external job.
credential_name:
type: string
description: Name of the credential to be used for an external job.
instance_id:
type: integer
description: Instance on which the user requests the job to run.
deferred_drop:
type: string
description: Indicates whether the job will be dropped when completed due to user request (TRUE) or not (FALSE).
allow_runs_in_restricted_mode:
type: string
description: Indicates whether the job is allowed to run in restricted session mode (TRUE) or not (FALSE).
comments:
type: string
description: Comments on the job.
flags:
type: integer
description: This column is for internal use.
restartable:
type: string
description: Indicates whether the job can be restarted (TRUE) or not (FALSE).
has_constraints:
type: string
description: Indicates whether the job (not including the program of the job) is part of a resource constraint or incompatibility (TRUE) or not (FALSE).
connect_credential_owner:
type: string
description: Owner of connect credential.
connect_credential_name:
type: string
description: Name of connect credential.
fail_on_script_error:
type: string
description: Indicates whether this job fails on script error (TRUE) or not (FALSE).
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/