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

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 Top

Response

Supported Media Types

200 Response

Success response
Body ()
Root Schema : GETDETAILS_response
Type: object
Show Source
Nested Schema : F1-GetBatchJobDetails
Type: object
Show Source
  • _self
  • batchControl
    The batch control code uniquely identifies a batch control record and its parameters and default values.
  • Maximum Length: 14
    The batch job submission ID is the system generated unique identifier of the request.
  • 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
  • Maximum Length: 26
    End Date/Time
  • 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
  • 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.
  • 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 Ready
    Example: 20
  • 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
Nested Schema : runInfoList
Type: object
Show Source
Nested Schema : runInfo
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • batchInstanceList
  • Minimum Value: -9.999999999E9
    Maximum Value: 9.999999999E9
    Thread Nbr
  • 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 time
    Example: Thread Nbr 1 - Complete Processed 714253 record(s) in 21 second(s)
  • 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 Ready
    Example: 20
Nested Schema : batchInstanceList
Type: object
Show Source
Nested Schema : batchInstance
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • 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
  • Maximum Length: 26
    End Date/Time
  • Maximum Length: 26
    Start Date/Time
  • runMessageList
  • 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 : runMessageList
Type: object
Show Source
Nested Schema : runMessage
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
  • Maximum Length: 254
    Message Text
  • 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