GetBatch
Retrieves details about a specific Salesforce batch job.
Input
| Name | Type | Description |
| JobId | String | The Salesforce Job ID that the batch belongs to. Required to identify the job context for the batch. |
| BatchId | String | The unique identifier of the specific batch being retrieved within the specified job. |
Result Set Columns
| Name | Type | Description |
| ID | String | The unique ID of the batch returned from Salesforce. |
| JobID | String | The ID of the job that this batch is associated with, confirming the parent job. |
| ApexProcessingTime | String | Time in milliseconds spent executing Apex triggers and workflow rules during batch processing. Excludes asynchronous or batch Apex execution. Available in API version 19.0 and above. |
| ApiActiveProcessingTime | String | Active processing time in milliseconds, including Apex processing but excluding queue time and serialization overhead. Available in API version 19.0 and above. |
| CreatedDate | String | Timestamp in UTC when the batch was created and added to the job. This does not indicate when processing began. |
| NumberRecordsFailed | String | Total number of records in the batch that failed to process. This helps identify partial success or issues during execution. |
| NumberRecordsProcessed | String | Number of records that have been successfully processed in this batch so far. Increases as processing progresses. |
| State | String | Current processing status of the batch. Possible values include 'Queued', 'InProgress', 'Completed', 'Failed', or 'Not Processed'. |
| StateMessage | String | Detailed explanation of the current batch state. Provides failure reasons if the state is Failed. May be truncated if there are many errors. |
| SystemModstamp | String | UTC timestamp of the last update to the batch, usually indicating when processing completed. Valid only when State is Completed. |
| TotalProcessingTime | String | Total time in milliseconds spent processing the batch, excluding queue wait time. Available in API version 19.0 and above. |