Represents an instance of a batch job that is either running and has been
run. This object is available in Life Sciences Cloud API version 65.0 and later.
Supported Calls
delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete()
Fields
AdditionalInformation
- Type: textarea
- Properties: Create, Nillable, Update
- Description: Additional information about the batch job. This field is available in API version 65.0 when Life Sciences Cloud is enabled.
BatchJobDefinitionId
- Type: reference
- Properties: Filter, Group, Sort
-
Description: The unique identifier of the associated batch job definition.
This is a relationship field.
- Relationship Name: BatchJobDefinition
- Relationship Type: Lookup
- Refers To: BatchJobDefinition
BatchJobDefinitionName
- Type: string
- Properties: Filter, Group, Sort
- Description: The developer name of the associated batch job definition.
BatchJobPartCount
- Type: int
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The count of the batch job parts. This field is available in API version 65.0 when Life Sciences Cloud is enabled.
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.
IsDebugOn
- Type: boolean
- Properties: Create, Defaulted on create, Filter, Group, Sort, Update
- Description: Indicates if debug mode is turned on.
- Default value: false
IsDebugRecipeDeleted
- Type: boolean
- Properties: Create, Defaulted on create, Filter, Group, Sort, Update
- Default value: false
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.
This is a polymorphic relationship field.
- Relationship Name: Owner
- Relationship Type: Lookup
- Refers To: Group, User
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 criteria 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:
- Canceled
- Completed
- CompletedWithFailures
- Failed
- InProgress
- Submitted
Type
- Type: picklist
- Properties: Defaulted on create, Filter, Group, Restricted picklist, Sort
- Description: The type of batch job that is run.
-
Possible values:
- Calc Data Processing Engine
- DecisionTableRefresh
- Flow
Associated Objects
This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.
- BatchJobFeed
- Change events are available for the object.
- BatchJobHistory
- Feed tracking is available for the object.