Get Batch Job / Batch Run Details
get
https://server:port/spl/rest/apis/common/batch/batchJobSubmission/{batchJobId}
This operation is used to retrieve the details related to a given batch job ID. Details related to the batch job submission record are returned. If the batch job has an associated batch run, then all the available batch run details are also returned.
Request
Path Parameters
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Nested Schema : F1-GetBatchJobDetails
Type:
Show Source
object
-
_self: string
_self
-
batchControl: object
batchControl
The batch control code uniquely identifies a batch control record and its parameters and default values.
-
batchJobId: string
Maximum Length:
14
The batch job submission ID is the system generated unique identifier of the request. -
businessDate: string
(date)
This is the batch business date in ISO format. It is only used for background processes that use a date in their processing where the date used should be set based on business rules. If this is left blank, the system date is used at the time the background process is executed.Example:
2020-01-01
-
endDateTime: string
Maximum Length:
26
End Date/Time -
jobStatus: string
Allowed Values:
[ "CA ", "ED ", "PC ", "PD ", "ST " ]
The batch job status flag indicates the current status of the batch job submission record. * `CA ` - Canceled, * `ED ` - Ended, * `PC ` - Pending Cancel, * `PD ` - Pending, * `ST ` - Started -
runInfoList: object
runInfoList
-
runNumber: number
Minimum Value:
-9.999999999E9
Maximum Value:9.999999999E9
The batch run number is allocated once the batch job starts processing. It's part of the unique identifier of a given batch run. -
runStatus: string
Allowed Values:
[ "20 ", "30 ", "40 ", "50 " ]
The batch run status defines the current status of the batch run created for this batch job. This is the overall status. Each thread submitted for the batch run has its own status value. Status values are numbers. * `20 ` - In Progress, * `30 ` - Error, * `40 ` - Complete, * `50 ` - Thread ReadyExample:20
-
startDateTime: string
Maximum Length:
26
Start Date/Time
Nested Schema : batchControl
Type:
object
The batch control code uniquely identifies a batch control record and its parameters and default values.
Show Source
-
_link: string
_link
-
batchControl: string
Maximum Length:
8
The batch control code uniquely identifies a batch control record and its parameters and default values.Example:F1-MGDIM
Nested Schema : items
Type:
Show Source
object
-
batchInstanceList: object
batchInstanceList
-
thread: number
Minimum Value:
-9.999999999E9
Maximum Value:9.999999999E9
Thread Nbr -
threadInfo: string
Maximum Length:
150
The thread information provides the same detail that one would see on the batch run tree in the application. The information includes the thread number, the status, the number of records processed and the elapsed timeExample:Thread Nbr 1 - Complete Processed 714253 record(s) in 21 second(s)
-
threadStatus: string
Allowed Values:
[ "10 ", "20 ", "25 ", "30 ", "40 ", "50 " ]
The thread status defines the status of the specific thread within the batch run. Values are represented by numbers. * `10 ` - Pending, * `20 ` - In Progress, * `25 ` - Interrupted, * `30 ` - Error, * `40 ` - Complete, * `50 ` - Thread ReadyExample:20
Nested Schema : items
Type:
Show Source
object
-
batchInstanceInfo: string
Maximum Length:
254
The batch instance information string provides the same information for a batch instance that one sees on the batch run tree in the application. Information includes the number of records processed and number in error, the start date and time in the format of the input user and Restart Data, if applicable.Example:Batch Instance 16 - Records Processed 714253 - Records in Error 0 - Start Date/Time 08-11-2021 08:47AM - End Date/Time 08-11-2021 08:48AM - Restart Data
-
instanceEndDateTime: string
Maximum Length:
26
End Date/Time -
instanceStartDateTime: string
Maximum Length:
26
Start Date/Time -
runMessageList: object
runMessageList
-
schedulerId: number
Minimum Value:
-9.999999999E9
Maximum Value:9.999999999E9
The batch instance ID is an internally generated ID that uniquely identifies the batch instance.Example:575115976
Nested Schema : items
Type:
Show Source
object
-
messageText: string
Maximum Length:
254
Message Text -
sequence: number
Minimum Value:
-999
Maximum Value:999
The batch parameter sequence number corresponds to the sequence number defined for the parameter on the batch control record.Example:10
400 Response
Bad Request
Root Schema : problemDetailDocument
Type:
Show Source
object
-
detail: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0
Maximum Value:9999
The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60
Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction. -
problemType: string
Maximum Length:
60
URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework. -
serverMessage: object
serverMessage
-
stackTrace: string
Maximum Length:
60
The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object
-
callSequence: string
Maximum Length:
60
Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0
Maximum Value:0
Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60
Name of the program that encountered the error.
500 Response
Internal Server Error
Root Schema : problemDetailDocument
Type:
Show Source
object
-
detail: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0
Maximum Value:9999
The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60
Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction. -
problemType: string
Maximum Length:
60
URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework. -
serverMessage: object
serverMessage
-
stackTrace: string
Maximum Length:
60
The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object
-
callSequence: string
Maximum Length:
60
Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0
Maximum Value:0
Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60
Name of the program that encountered the error.