Submit Batch Job
post
https://server:port/spl/rest/apis/common/batch/batchJobSubmission/
This operation is used to add a batch job submission record for the input batch control. This API results in a generated Batch Job ID which can be used to review the status and potentially cancel the request, if needed. No defaulting of values from the batch control are performed. Callers are expected to provide the appropriate parameters expected by the batch control.
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Nested Schema : jobDetails
Type:
Show Source
object
-
batchControl: string
Maximum Length:
8
The batch control code associated with the batch program to submit.Example:F1-MGDIM
-
batchJobExtraParameter: array
batchJobExtraParameter
The batch parameters are defined on the batch control table for this batch control. The submission request should include values for the required batch parameters.
-
batchRerunNumber: number
Minimum Value:
-9.999999999E9
Maximum Value:9.999999999E9
Batch Rerun Number is used to request a rerun of a previous batch run number. This is applicable to extract type processes or other batch processes where reprocessing of the same data is supported. -
batchStartDateTime: string
(date-time)
The batch start date / time defaults to the current date and time. Override this information if you wish the background process to be executed at some future date and time. This is in ISO format.Example:
2020-01-01.10:00.00
-
batchThreadNumber: number
Minimum Value:
-9.999999999E9
Maximum Value:9.999999999E9
The thread number should be typically be populated with 0. The only time this value should be populated is if a previous thread of a previous run is in error and you wish to restart a specific thread of that run. Refer to the online help topic "Running Multi-Threaded Processes" for more information.Example:1
-
emailAddress: string
Maximum Length:
254
Provide an email address if you wish the system to notify you when the batch job is complete. If left blank and a value is found on the associated user record, that is used.Example:batch.notification@company.com
-
isTracingProgramEnd: boolean
This is only used for testing or troubleshooting. If trace program exit is set to 'Y', a message is displayed whenever a program is exited.
-
isTracingProgramStart: boolean
This is only used for testing or troubleshooting. If trace program start is set to Y, a message is displayed whenever a program is started.
-
isTracingSQL: boolean
This is only used for testing or troubleshooting. If trace SQL is set to 'Y', a message is displayed whenever an SQL statement is executed.
-
isTracingStandardOut: boolean
This is only used for testing or troubleshooting. If trace output is set to 'Y', special messages formatted by the specific background process are written, if applicable.
-
language: string
Maximum Length:
3
Language is used to access language-specific control table values. If not provided, the value from the associated use is used.Example:ENG
-
maximumCommitRecords: number
Minimum Value:
0
Maximum Value:9.999999999E9
Only populate a value here to override the program's Maximum Commit Interval (which determines the size of database transaction).Example:200
-
maximumTimeoutMinutes: number
Minimum Value:
0
Maximum Value:9.999999999E9
Only populate a value in the Maximum Timeout (in minutes) if you need to override the default value for the program.Example:15
-
processDate: 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
-
threadCount: number
Minimum Value:
-9.999999999E9
Maximum Value:9.999999999E9
Thread Count is used to control whether a background processes is run single threaded or in multiple parallel threads. It contains the total number of threads that have been requested.Example:5
-
user: string
Maximum Length:
8
Provide a user id to associated with the run of the background process. It may differ from the user provided for authentication of the web service call. Any batch process that stamps a user ID on a record it creates or updates uses this user ID in applicable processing.
Nested Schema : batchJobExtraParameter
Type:
array
The batch parameters are defined on the batch control table for this batch control. The submission request should include values for the required batch parameters.
Show Source
Nested Schema : items
Type:
Show Source
object
-
batchParameterName: string
Maximum Length:
30
The parameter name uniquely identifies the parameter defined on the batch control. -
batchParameterValue: string
Maximum Length:
254
The parameter value should be populated with the appropriate desired parameter value for the given parameter. -
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
Nested Schema : jobDetails
Type:
Show Source
object
-
batchControl: string
Maximum Length:
8
The batch control code associated with the batch program to submit.Example:F1-MGDIM
-
batchJobExtraParameter: array
batchJobExtraParameter
The batch parameters are defined on the batch control table for this batch control. The submission request should include values for the required batch parameters.
-
batchRerunNumber: number
Minimum Value:
-9.999999999E9
Maximum Value:9.999999999E9
Batch Rerun Number is used to request a rerun of a previous batch run number. This is applicable to extract type processes or other batch processes where reprocessing of the same data is supported. -
batchStartDateTime: string
(date-time)
The batch start date / time defaults to the current date and time. Override this information if you wish the background process to be executed at some future date and time. This is in ISO format.Example:
2020-01-01.10:00.00
-
batchThreadNumber: number
Minimum Value:
-9.999999999E9
Maximum Value:9.999999999E9
The thread number should be typically be populated with 0. The only time this value should be populated is if a previous thread of a previous run is in error and you wish to restart a specific thread of that run. Refer to the online help topic "Running Multi-Threaded Processes" for more information.Example:1
-
emailAddress: string
Maximum Length:
254
Provide an email address if you wish the system to notify you when the batch job is complete. If left blank and a value is found on the associated user record, that is used.Example:batch.notification@company.com
-
isTracingProgramEnd: boolean
This is only used for testing or troubleshooting. If trace program exit is set to 'Y', a message is displayed whenever a program is exited.
-
isTracingProgramStart: boolean
This is only used for testing or troubleshooting. If trace program start is set to Y, a message is displayed whenever a program is started.
-
isTracingSQL: boolean
This is only used for testing or troubleshooting. If trace SQL is set to 'Y', a message is displayed whenever an SQL statement is executed.
-
isTracingStandardOut: boolean
This is only used for testing or troubleshooting. If trace output is set to 'Y', special messages formatted by the specific background process are written, if applicable.
-
language: string
Maximum Length:
3
Language is used to access language-specific control table values. If not provided, the value from the associated use is used.Example:ENG
-
maximumCommitRecords: number
Minimum Value:
0
Maximum Value:9.999999999E9
Only populate a value here to override the program's Maximum Commit Interval (which determines the size of database transaction).Example:200
-
maximumTimeoutMinutes: number
Minimum Value:
0
Maximum Value:9.999999999E9
Only populate a value in the Maximum Timeout (in minutes) if you need to override the default value for the program.Example:15
-
processDate: 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
-
threadCount: number
Minimum Value:
-9.999999999E9
Maximum Value:9.999999999E9
Thread Count is used to control whether a background processes is run single threaded or in multiple parallel threads. It contains the total number of threads that have been requested.Example:5
-
user: string
Maximum Length:
8
Provide a user id to associated with the run of the background process. It may differ from the user provided for authentication of the web service call. Any batch process that stamps a user ID on a record it creates or updates uses this user ID in applicable processing.
Nested Schema : batchJobExtraParameter
Type:
array
The batch parameters are defined on the batch control table for this batch control. The submission request should include values for the required batch parameters.
Show Source
Nested Schema : items
Type:
Show Source
object
-
batchParameterName: string
Maximum Length:
30
The parameter name uniquely identifies the parameter defined on the batch control. -
batchParameterValue: string
Maximum Length:
254
The parameter value should be populated with the appropriate desired parameter value for the given parameter. -
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
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Nested Schema : jobDetails
Type:
Show Source
object
-
batchControl: string
Maximum Length:
8
The batch control code associated with the batch program to submit.Example:F1-MGDIM
-
batchJobExtraParameter: array
batchJobExtraParameter
The batch parameters are defined on the batch control table for this batch control. The submission request should include values for the required batch parameters.
-
batchJobId: string
Maximum Length:
14
The batch job submission ID is the system generated unique identifier of the request. -
batchNumber: 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. -
batchRerunNumber: number
Minimum Value:
-9.999999999E9
Maximum Value:9.999999999E9
Batch Rerun Number is used to request a rerun of a previous batch run number. This is applicable to extract type processes or other batch processes where reprocessing of the same data is supported. -
batchStartDateTime: string
(date-time)
The batch start date / time defaults to the current date and time. Override this information if you wish the background process to be executed at some future date and time. This is in ISO format.Example:
2020-01-01.10:00.00
-
batchThreadNumber: number
Minimum Value:
-9.999999999E9
Maximum Value:9.999999999E9
The thread number should be typically be populated with 0. The only time this value should be populated is if a previous thread of a previous run is in error and you wish to restart a specific thread of that run. Refer to the online help topic "Running Multi-Threaded Processes" for more information.Example:1
-
emailAddress: string
Maximum Length:
254
Provide an email address if you wish the system to notify you when the batch job is complete. If left blank and a value is found on the associated user record, that is used.Example:batch.notification@company.com
-
isTracingProgramEnd: boolean
This is only used for testing or troubleshooting. If trace program exit is set to 'Y', a message is displayed whenever a program is exited.
-
isTracingProgramStart: boolean
This is only used for testing or troubleshooting. If trace program start is set to Y, a message is displayed whenever a program is started.
-
isTracingSQL: boolean
This is only used for testing or troubleshooting. If trace SQL is set to 'Y', a message is displayed whenever an SQL statement is executed.
-
isTracingStandardOut: boolean
This is only used for testing or troubleshooting. If trace output is set to 'Y', special messages formatted by the specific background process are written, if applicable.
-
language: string
Maximum Length:
3
Language is used to access language-specific control table values. If not provided, the value from the associated use is used.Example:ENG
-
maximumCommitRecords: number
Minimum Value:
0
Maximum Value:9.999999999E9
Only populate a value here to override the program's Maximum Commit Interval (which determines the size of database transaction).Example:200
-
maximumTimeoutMinutes: number
Minimum Value:
0
Maximum Value:9.999999999E9
Only populate a value in the Maximum Timeout (in minutes) if you need to override the default value for the program.Example:15
-
processDate: 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
-
submissionMethod: string
Allowed Values:
[ "F1GE", "F1ON", "F1OT", "F1SC", "F1TD" ]
The submission method flag is informational and indicates how the batch job was submitted. * `F1GE` - Generated, * `F1ON` - Online, * `F1OT` - Other, * `F1SC` - Scheduled, * `F1TD` - TimedExample:F1ON
-
threadCount: number
Minimum Value:
-9.999999999E9
Maximum Value:9.999999999E9
Thread Count is used to control whether a background processes is run single threaded or in multiple parallel threads. It contains the total number of threads that have been requested.Example:5
-
user: string
Maximum Length:
8
Provide a user id to associated with the run of the background process. It may differ from the user provided for authentication of the web service call. Any batch process that stamps a user ID on a record it creates or updates uses this user ID in applicable processing.
Nested Schema : batchJobExtraParameter
Type:
array
The batch parameters are defined on the batch control table for this batch control. The submission request should include values for the required batch parameters.
Show Source
Nested Schema : items
Type:
Show Source
object
-
batchParameterName: string
Maximum Length:
30
The parameter name uniquely identifies the parameter defined on the batch control. -
batchParameterValue: string
Maximum Length:
254
The parameter value should be populated with the appropriate desired parameter value for the given parameter. -
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.