Jump to

• Request
• Response

Get all Oracle Scheduler jobs

get

/database/scheduler/jobs/

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.

Request

Query Parameters

• limit: integer(int32)
  The maximum number of records to return.
• q:
  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.

  Examples

  Select an example FilterCriteriaExample OrderByPropertyExample FilterAndOrderExample

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Description of all jobs in the database.

Body ()

Root Schema : SchedulerJobs

Type: object

Show Source

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

{
    "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"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object SchedulerJobsItem
  Represents a row in ALL_SCHEDULER_JOBS or DBA_SCHEDULER_JOBS views. See Oracle Database Reference documenation for more details.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SchedulerJobsItem"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LinkRelation

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

Nested Schema : SchedulerJobsItem

Type: object

Represents a row in ALL_SCHEDULER_JOBS or DBA_SCHEDULER_JOBS views. See Oracle Database Reference documenation for more details.

Show Source

• allow_runs_in_restricted_mode: string
  Indicates whether the job is allowed to run in restricted session mode (TRUE) or not (FALSE).
• auto_drop: string
  Indicates whether the job will be dropped when it has completed (TRUE) or not (FALSE).
• client_id: string
  Client identifier of the user creating the job.
• comments: string
  Comments on the job.
• connect_credential_name: string
  Name of connect credential.
• connect_credential_owner: string
  Owner of connect credential.
• credential_name: string
  Name of the credential to be used for an external job.
• credential_owner: string
  Owner of the credential to be used for an external job.
• deferred_drop: string
  Indicates whether the job will be dropped when completed due to user request (TRUE) or not (FALSE).
• destination: string
  Destination that this job will run on.
• destination_owner: string
  Owner of the destination object (if used), else NULL.
• enabled: string
  Indicates whether the job is enabled (TRUE) or disabled (FALSE).
• end_date: string
  Date after which the job will no longer run (for an inline schedule).
• event_condition: string
  Boolean expression used as the subscription rule for the event on the source queue.
• event_queue_agent: string
  Name of the AQ agent used by the user on the event source queue (if it is a secure queue).
• event_queue_name: string
  Name of the source queue into which the event will be raised.
• event_queue_owner: string
  Owner of the source queue into which the event will be raised.
• event_rule: string
  Name of the rule used by the coordinator to trigger the event-based job.
• fail_on_script_error: string
  Indicates whether this job fails on script error (TRUE) or not (FALSE).
• failure_count: integer
  Number of times the job has failed to run.
• file_watcher_name: string
  Name of the file watcher on which this job is based.
• file_watcher_owner: string
  Owner of the file watcher on which this job is based.
• flags: integer
  This column is for internal use.
• global_uid: string
  Global user identifier of the user creating the job.
• has_constraints: string
  Indicates whether the job (not including the program of the job) is part of a resource constraint or incompatibility (TRUE) or not (FALSE).
• instance_id: integer
  Instance on which the user requests the job to run.
• instance_stickiness: string
  Indicates whether the job is sticky (TRUE) or not (FALSE).
• job_class: string
  Name of the job class associated with the job.
• job_creator: string
  Original creator of the job.
• job_name: string
  Name of the Scheduler job.
• job_priority: integer
  Priority of the job relative to other jobs in the same class.
• job_style: string
  Job style: REGULAR, LIGHTWEIGHT, IN_MEMORY_RUNTIME, IN_MEMORY_FULL.
• job_subname: string
  Subname of the Scheduler job (for a job running a chain step).
• job_type: string
  Inline job action type.
• job_weight: integer
  Weight of the job.
• last_run_duration: string
  Amount of time the job took to complete during the last run.
• last_start_date: string
  Last date on which the job started running.
• links: array links
• logging_level: string
  Amount of logging that will be done pertaining to the job.
• max_failures: integer
  Number of times the job will be allowed to fail before being marked broken.
• max_run_duration: string
  Maximum amount of time for which the job will be allowed to run.
• max_runs: integer
  Maximum number of times the job is scheduled to run.
• next_run_date: string
  Next date on which the job is scheduled to run.
• nls_env: string
  NLS environment of the job.
• number_of_destinations: integer
  Number of destinations associated with this job.
• owner: string
  Owner of the Scheduler job.
• program_name: string
  Name of the program associated with the job.
• program_owner: string
  Owner of the program associated with the job.
• raise_events: string
  List of job events to raise for the job.
• repeat_interval: string
  Inline schedule PL/SQL expression or calendar string.
• restart_on_failure: string
  Indicates whether the step should be restarted on application failure (TRUE) or not (FALSE).
• restart_on_recovery: string
  Indicates whether the step should be restarted on database recovery (TRUE) or not (FALSE).
• restartable: string
  Indicates whether the job can be restarted (TRUE) or not (FALSE).
• retry_count: integer
  Number of times the job has retried, if it is retrying.
• run_count: integer
  Number of times the job has run.
• schedule_limit: string
  Time after which a job which has not run yet will be rescheduled.
• schedule_name: string
  Name of the schedule that the job uses (can be a window or a window group)
• schedule_owner: string
  Owner of the schedule that the job uses (can be a window or a window group)
• schedule_type: string
  Type of the schedule that the job uses.
• source: string
  Source global database identifier.
• start_date: string
  Original scheduled start date of the job (for an inline schedule).
• state: string
  Current state of the job.
• stop_on_window_close: string
  Indicates whether the job will stop if a window associated with the job closes (TRUE) or not (FALSE).
• store_output: string
  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.
• system: string
  Indicates whether the job is a system job (TRUE) or not (FALSE).
• uptime_failure_count: integer
  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.
• uptime_run_count: integer
  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.

{
    "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"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LinkRelation

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

Nested Schema : LinkRelation

Type: object

Show Source

• href(required): string
• rel(required): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    },
    "required":[
        "rel",
        "href"
    ]
}

Back to Top