1. Oracle Utilities REST API for Metering and Customer Information
  2. Tasks
  3. Batch Services
  4. Batch Job Submission

Submit Batch Job

post

/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. The system defaults the values of the parameters from the batch control, if not provided by the caller. When providing parameters, only the parameter name and parameter value are required. The sequence may be provided but is not necessary. Note that if default values are defined for a required parameter, that value is used if not provided by the caller. Default values defined on the batch control for optional parameters are ignored.

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/xml ()
Root Schema : schema
Type: object
Show Source
Nested Schema : F1SubmitJob
Type: object
Show Source
Nested Schema : jobDetails
Type: object
Show Source
  • Maximum Length: 8
    The batch control code associated with the batch program to submit.
    Example: F1-MGDIM
  • batchJobExtraParameter
    The batch parameters are defined on the batch control table for this batch control. The submission request should include parameter name and parameter value for every required parameter that does not have a default value defined from the batch control or where a different value than the batch control is desired. For optional parameters, if a value is desired, it should be provided. Any default value on the batch control for optional parameters is ignored.
  • 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.
  • 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
  • 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
  • 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
  • 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.
  • 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.
  • 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.
  • 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.
  • 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
  • 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
  • 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
  • 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
  • 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
  • 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 parameter name and parameter value for every required parameter that does not have a default value defined from the batch control or where a different value than the batch control is desired. For optional parameters, if a value is desired, it should be provided. Any default value on the batch control for optional parameters is ignored.
Show Source
Nested Schema : items
Type: object
Show Source
  • Maximum Length: 30
    The parameter name uniquely identifies the parameter defined on the batch control.
  • Maximum Length: 254
    The parameter value should be populated with the appropriate desired parameter value for the given parameter.
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : F1SubmitJob
Type: object
Show Source
Nested Schema : jobDetails
Type: object
Show Source
  • Maximum Length: 8
    The batch control code associated with the batch program to submit.
    Example: F1-MGDIM
  • batchJobExtraParameter
    The batch parameters are defined on the batch control table for this batch control. The submission request should include parameter name and parameter value for every required parameter that does not have a default value defined from the batch control or where a different value than the batch control is desired. For optional parameters, if a value is desired, it should be provided. Any default value on the batch control for optional parameters is ignored.
  • 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.
  • 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
  • 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
  • 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
  • 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.
  • 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.
  • 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.
  • 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.
  • 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
  • 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
  • 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
  • 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
  • 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
  • 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 parameter name and parameter value for every required parameter that does not have a default value defined from the batch control or where a different value than the batch control is desired. For optional parameters, if a value is desired, it should be provided. Any default value on the batch control for optional parameters is ignored.
Show Source
Nested Schema : items
Type: object
Show Source
  • Maximum Length: 30
    The parameter name uniquely identifies the parameter defined on the batch control.
  • Maximum Length: 254
    The parameter value should be populated with the appropriate desired parameter value for the given parameter.
  • 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
Back to Top

Response

Supported Media Types

200 Response

Success response
Body ()
Root Schema : SUBMIT_response
Type: object
Show Source
Nested Schema : F1SubmitJob
Type: object
Show Source
Nested Schema : jobDetails
Type: object
Show Source
  • Maximum Length: 8
    The batch control code associated with the batch program to submit.
    Example: F1-MGDIM
  • batchJobExtraParameter
    The batch parameters are defined on the batch control table for this batch control. The submission request should include parameter name and parameter value for every required parameter that does not have a default value defined from the batch control or where a different value than the batch control is desired. For optional parameters, if a value is desired, it should be provided. Any default value on the batch control for optional parameters is ignored.
  • Maximum Length: 14
    The batch job submission ID is the system generated unique identifier of the request.
  • 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.
  • 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.
  • 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
  • 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
  • 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
  • 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.
  • 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.
  • 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.
  • 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.
  • 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
  • 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
  • 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
  • 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
  • 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` - Timed
    Example: F1ON
  • 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
  • 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 parameter name and parameter value for every required parameter that does not have a default value defined from the batch control or where a different value than the batch control is desired. For optional parameters, if a value is desired, it should be provided. Any default value on the batch control for optional parameters is ignored.
Show Source
Nested Schema : items
Type: object
Show Source
  • Maximum Length: 30
    The parameter name uniquely identifies the parameter defined on the batch control.
  • Maximum Length: 254
    The parameter value should be populated with the appropriate desired parameter value for the given parameter.
  • 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
Body ()
Root Schema : problemDetailDocument
Type: object
Show Source
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 9999
    The HTTP Status code for the error.
  • 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.
  • 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
  • Maximum Length: 60
    The stack trace shows where the error occurs during the execution of a program.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type: object
Show Source
  • Maximum Length: 60
    Delimited sequence of programs called.
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 0
    Message Category within Oracle Utilities Application Framework.
  • Minimum Value: -99999
    Maximum Value: 99999
    Message Number within Oracle Utilities Application Framework.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
  • Maximum Length: 60
    Name of the program that encountered the error.

500 Response

Internal Server Error
Body ()
Root Schema : problemDetailDocument
Type: object
Show Source
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 9999
    The HTTP Status code for the error.
  • 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.
  • 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
  • Maximum Length: 60
    The stack trace shows where the error occurs during the execution of a program.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type: object
Show Source
  • Maximum Length: 60
    Delimited sequence of programs called.
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 0
    Message Category within Oracle Utilities Application Framework.
  • Minimum Value: -99999
    Maximum Value: 99999
    Message Number within Oracle Utilities Application Framework.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
  • Maximum Length: 60
    Name of the program that encountered the error.
Back to Top