1. REST API for Common Features in Oracle Fusion Cloud Applications
  2. Tasks
  3. Scheduler

Query job requests

get

ess/rest/scheduler/v1/requests

Queries job requests. Job requests represent executable instances of job definitions or job sets.

Request

Query Parameters
  • Common-separated list of fields to exclude in the information returned. For example, ?excludeFields="jobDefinitionId"
  • Common-separated list of fields to return. For example, ?fields="requestId"
  • A comma-separated list of request IDs to return request information for.
  • Specify a query field by which to order the results. The value of this query parameter must follow the format of fieldName[:(asc/desc)]. For example, ?orderBy=name:asc. If more than one field is listed, only the first will be used.
  • Query string in SCIM filtering format. Fields that can be queried include [requestId, absParentRequestId, description, application, product, requestCategory, runAsUser, executionType, jobDefinitionId, state, scheduleDefinition, priority, processStartTime, processEndTime, requestedStartTime, requestedEndTime, submissionTime, parentRequestId, elapsedTime, waitTime, scheduledTime, processor, submitter, submitterGUID, instanceParentId, requestType, errorType, processPhase, completedTime, retriedCount, readyWaitTime, enterpriseId, isTimedOut, isAsynchronous, logicalClusterName, submitterDmsECID, submitterFlowId, requestDmsECID, requestFlowId, elapsedTime, className, jobType, externalJobType, externalId]

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : RequestQueryResponse
Type: object
Show Source
Nested Schema : batch
Type: array
The items returned for multi-selection. This element is not returned for a normal query.
Show Source
Nested Schema : items
Type: array
The resource items returned for a normal query. This element is not returned when multi-select is used.
Show Source
Nested Schema : RequestBatchItem
Type: object
Show Source
Nested Schema : RequestDetails
Type: object
Show Source
  • The submitted request ID. All child requests created on behalf of that request have the same absolute parent.
  • The application name associated with this request.
  • Allowed Values: [ "NON_TERMINAL", "REQUEST_EXPIRED", "REQUEST_LOGIN_ERROR", "REQUEST_AUTHORIZATION_FAILED", "SYSTEM_ERROR", "VALIDATION_ERROR", "METADATA_NOT_FOUND", "OPERATOR_CANCEL", "RECOVER_CANCEL", "RECOVER_GROUP_CANCEL", "PARENT_NOT_PAUSED", "PROCESS_WARNING", "PROCESS_ERROR", "PROCESS_CANCEL", "PROCESS_SUCCESS", "PROCESS_SYSTEM_ERROR", "PROCESS_BIZ_ERROR", "PROCESS_TIMED_OUT", "PROCESS_UNKNOWN_STATUS", "PROCESS_RECOVER", "PROCESS_MANUAL_RECOVER_ERROR", "PROCESS_MANUAL_RECOVER_ERROR_FINALIZE", "PROCESS_SUSPEND", "PROCESS_KILLED", "POSTPROCESS_SYSTEM_ERROR", "POSTPROCESS_CANCEL", "POSTPROCESS_WARNING", "POSTPROCESS_ERROR", "POSTPROCESS_BIZ_ERROR", "PROCESS_UPDATE_WARNING", "PROCESS_UPDATE_ERROR", "PROCESS_UPDATE_CANCEL", "PROCESS_UPDATE_BIZ_ERROR", "MANUAL_RECOVER_ERROR", "PREPROCESS_SYSTEM_ERROR", "PREPROCESS_CANCEL", "PREPROCESS_INITIATE_CANCEL", "PREPROCESS_ERROR", "PREPROCESS_BIZ_ERROR" ]
    The cause that led to the request being in a terminal state.
  • A localized string describing the general cause of the state of the job request.
  • The time, in ISO 8601 date time format, that ESS finished all tasks associated with this request. This represents the time that the request process phase was set to ProcessPhase.Complete. This value will always be set once all tasks for the request has finished, even if the request was never executed for some reason. Null is returned if ESS has not yet finished all work for this requests.
  • The deployedApplicationName name associated with this request.
  • The description of this request.
  • The mid-tier instance name that dispatched the request.
  • The ECID of the DMS ExecutionContext associated with the processing of this request.
  • The elapsed milliseconds spent processing request. This will be zero 0 if the request processing not started.
  • Allowed Values: [ "SYSTEM", "BUSINESS", "TIMEOUT", "MIXED_NON_BUSINESS", "MIXED_BUSINESS" ]
    The error type of the request.
  • Localized error type message.
  • The details, such as stack trace, of the error or warning, if one occurred while processing this request.
  • The message associated with an error or warning that occured while processing this request.
  • The time, in ISO 8601 date time format, of the error or warning if one occurred while processing this request.
  • The current execution attempt for this request. The first execution attempt is 1.
  • The execution type of the request. The only type supported now is REST.
  • The time, in ISO 8601 date time format, that the request will expire. A request may not expire.
  • The value of execution attempt of the instance parent request when this request was created. This value will be zero if this request does not have an instance parent
  • The request id of the instance parent of this request. Any child requests of request tree of the instance parent request have he same instance parent id. For example, any sub-requests or JobSet step requests, and any of their children, will have the same instance parent id. If a request is submitted without a Schedule the submitted request is considered the instance parent. The instance parent id value is the same as the absolute parent id value. If a request is submitted with a Schedule, a new child request is created for each occurance of the Schedule and each child request represents an instance parent request.
  • Indicates if the request is asynchronous. A value of 'true' indicates that this is an asynchronous request.
  • Indicates if the request is cancellable. This is based on the request type and current state of this request. This is only a hint, not a guarantee, as to whether or not this request can be cancelled.
  • Check whether the prerequisites for forcing a request to CANCELLED using forceCancelAsyncRequest are met. The checks do NOT include verification that the job request is no longer executing. That check must be done manually.
  • Indicates if the request is holdable. This is based on the request type and current state of this request. This is only a hint, not a guarantee, as to whether or not this request can be held.
  • Indicates if the request has timed out.
  • The job or job set definition associated with this request.
  • the description of the job definition or job set specified for this request
  • The display name for job definition/ job set of this request.
  • The job type identifier associated with this request.
  • The last Schedule instance request id associated with this request. This value is meaningful only for certain request types. For other request types it is meaningless and will be zero (0). For a RequestType.RECUR_PARENT or RequestType.JOBSET_RECUR_PARENT request, this value represents the id of the instance parent request that was most recently created. If the Schedule has ended, or been cancelled, this is the id of the last instance request created for the Schedule. For a RequestType.RECUR_CHILD or RequestType.JOBSET_RECUR_CHILD request, this value represents the id of the request for the previous instance of the Schedule. The value is zero (0) for the first instance request of the Schedule.
  • The set number assigned to the last subrequest submitted by this request during its current execution attempt. This value will be zero if no subrequests have been submitted by this request. If pausedCount equals lastSubrequestSet, then this request has paused since the last subrequests were submitted. This value represents the set number assigned to those subrequests. If pausedCount is not equal to lastSubrequestSet, then one or more subrequests have been submitted since this request last paused. This value represents the set number assigned to those subrequests that are waiting for this request to pause.
  • RequestLinks
  • URL for an optional notification callback when the request is complete to be made as the user who submitted the request.
  • The value of execution attempt of the immediate parent request when this request was created. This value will be zero if this request does not have an immediate parent.
  • The request ID of the immediate parent of this request. If the request has no immediate parent, the value returned by this method as not meaningful.
  • The number of times this request has been paused during its current execution attempt. This value is incremented when a request has been paused to allow to allow sub-requests to run. This value will be zero if this request has never been paused.
  • The previous state for this request. It may be empty if the request has never changed state.
  • The request priority. The priorty range is [0..9] with 0 as the lowest priority and 9 as the highest priority.
  • Time processing of the request ended in ISO 8601 date time format.
  • The process group of the request.
  • The mid-tier instance name that processed the request.
  • The process phase for this request.
  • Localized description of the process phase.
  • Time processing of the request began in ISO 8601 date time format.
  • The product associated with the request. This corresponds to the value of SYS_product system property.
  • The request category property of this request.
  • This represents the requested end time of the request. The string is in ISO 8601 date time format.
  • The time at which the request was requested to run. The string is in ISO 8601 date time format.
  • requestParameters
    All request parameters, including system properties, associated with this request.
  • Allowed Values: [ "SINGLETON", "RECUR_PARENT", "RECUR_CHILD", "JOBSET_SINGLETON", "JOBSET_STEP", "JOBSET_RECUR_PARENT", "JOBSET_RECUR_CHILD", "SUB_REQUEST", "UNKNOWN" ]
    The immutable type of the request.
  • The number of times this request has been retried.
  • The RunAs user for the request.
  • ScheduleOut
  • Identifies the schedule associated with this request only if the schedule is a separate resource. For a schedule specified inline during request submission (ad-hoc schedule), see 'schedule' field.
  • The scheduled start time of the request. The string is in ISO 8601 date time format.
  • The state of the request.
  • The time the request state was last changed in ISO 8601 date time format. It may be empty if the request has never changed state.
  • A localized string describing the state of the job request.
  • The JobSet stepID for this request. The request may or may not be a step within a JobSet, which can be indicated by the stepID value.
  • Time of request submission in ISO8601 date time format.
  • The name of the user who submitted the request.
  • The GUID of the user who submitted the request.
  • The set number assigned to a subrequest when it was submitted. If a parent submits multiple subrequests before it pauses all those subrequests will have the same set number. This is meaningful only for a subrequest, in which case this value will be greater than zero. The value is zero for a request that is not a subrequest.
Nested Schema : requestParameters
Type: array
All request parameters, including system properties, associated with this request.
Show Source
Nested Schema : ScheduleOut
Match All
Show Source
Nested Schema : RequestParameter
Type: object
A request parameter.
Show Source
Nested Schema : ScheduleBase
Type: object
Show Source
Nested Schema : ScheduleOut-allOf[1]
Type: object
Show Source
Nested Schema : exclusions
Type: array
Show Source
Nested Schema : inclusions
Type: array
Show Source
Nested Schema : recurrences
Type: array
A set of recurrences. The resulting occurrences for the schedule would be the union of occurrences generated by the individual recurrences.
Show Source
Nested Schema : Recurrence
Type: object
Show Source
  • Sets the end date/time for this Recurrence object. The object only extracts the time up to the seconds. Milliseconds precision is not supported. The value is a string in ISO 8601 format.
  • Defines a recurrence pattern for use by a schedule. The string must conform to RFC 5445 RRULE. Restrictions include UNTIL, COUNT, BYSETPOS and WKST are not supported. BY* clauses (Rotors) in the RRULE can have minimun value of -1. i.e. for eg, BYDAY=-2MO(second to last monday) is not supported. BYMONTH and BYWEEKNO can't be present in one RECUR expression. BYDAY, BYMONTHDAY and BYYEARDAY can't be present in one RECUR expression.
  • Sets the start date/time for this Recurrence object. The object only extracts the time up to the seconds. Milliseconds precision is not supported. The value is a string in ISO 8601 format.
Nested Schema : permissions
Type: array
The set of permissions the current user of this API has on this resource.
Show Source
  • Allowed Values: [ "READ", "CREATE", "UPDATE", "DELETE", "EXECUTE" ]
Nested Schema : resourceBundles
Type: array
Java resource bundles associated with this job.
Show Source

400 Response

Invalid input
Body ()
Root Schema : SimpleExceptionDetail
Type: object
Show Source

403 Response

Not allowed for this operation
Body ()
Root Schema : SimpleExceptionDetail
Type: object
Show Source

404 Response

Not found
Body ()
Root Schema : SimpleExceptionDetail
Type: object
Show Source

500 Response

A scheduling sub-system error occurred
Body ()
Root Schema : SimpleExceptionDetail
Type: object
Show Source
Back to Top