Skip Navigation

Newer Version Available

This content describes an older version of this product. View Latest

BatchJob

Represents an instance of a batch job that is either running and has been run. This object is available in API version 51.0 and later.

Supported Calls

describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search()

Fields

Field	Details
BatchJobDefinitionId	Type reference Properties Filter, Group, Sort Description The unique identifier of the associated batch job definition.
BatchJobDefinitionName	Type string Properties Filter, Group, Sort Description The developer name of the associated batch job definition.
EndTime	Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the batch job run was completed.
ErrorDescription	Type string Properties Filter, Nillable, Sort Description The error message in case the batch job run failed.
ExternalReference	Type string Properties Filter, Group, Nillable, Sort Description The unique identifier of the process that's running or has run the batch job.
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed the batch job.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this item.
Name	Type string Properties Filter, Group, idLookup, Sort Description The name of the batch job.
OwnerId	Type reference Properties Filter, Group, Sort Description Unique identifier of the user who initiated the batch job run.
ProcessGroup	Type string Properties Filter, Group, Sort Description The group or team for which the batch job is run.
RetryCount	Type int Properties Filter, Group, Nillable, Sort Description The number of times the batch job run is automatically rerun in case it fails.
RuntimeParameter	Type textarea Properties Nillable Description The values of the input variables that are used as filter criterias in a Batch Management job.
StartTime	Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the batch job run was started.
Status	Type picklist Properties Filter, Group, Restricted picklist, Sort Description The status of the batch job run. Possible values are: `Cancelled`—Canceled `Completed` `CompletedWithFailures`—Completed With Failures `Failed` `InProgress`—In Progress `Submitted`
Type	Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description The type of batch job that is run. Possible values are: `Calc`—Data Processing Engine `Flow`