{"id":"sforce_api_objects_crontrigger","title":"CronTrigger","content":"

CronTrigger

\n
Contains schedule information for a scheduled\n job. CronTrigger is similar to a cron job on UNIX systems. This object is available in API\n version 17.0 and later.
\n\n
\n

Supported Calls

\n\n \n

describeSObjects(), query(), retrieve()

\n\n
\n\n
\n

Fields

\n\n \n \n
\n \n \n \n \n \n\n \n\n \n\n \n\n \n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n
FieldDetails
CronExpression\n
\n \n
Type
\n\n
string
\n\n \n \n
Properties
\n\n
Filter, Group, Nillable, Sort
\n\n \n \n
Description
\n\n
The cron expression used to initiate the schedule.
\n\n
Syntax:
Seconds Minutes Hours Day_of_month Month Day_of_week Optional_year
\n
\n\n
See schedule(jobName,\n cronExpression, schedulableClass) in the Apex Reference\n Guide.
\n\n \n
\n\n
CronJobDetailId\n
\n \n
Type
\n\n
reference
\n\n \n \n
Properties
\n\n
Filter, Group, Nillable, Sort
\n\n \n \n
Description
\n\n
The ID of the CronJobDetail record containing more details about this scheduled\n job.
\n\n
This is a relationship field.
\n\n \n \n
Relationship Name
\n\n
CronJobDetail
\n\n \n \n
Relationship Type
\n\n
Lookup
\n\n \n \n
Refers To
\n\n
CronJobDetail
\n\n \n
\n\n
EndTime\n
\n \n
Type
\n\n
dateTime
\n\n \n \n
Properties
\n\n
Filter, Nillable, Sort
\n\n \n \n
Description
\n\n
The date and time when the job either finished or will finish.
\n\n \n
\n\n
NextFireTime\n
\n \n
Type
\n\n
dateTime
\n\n \n \n
Properties
\n\n
Filter, Nillable, Sort
\n\n \n \n
Description
\n\n
The next date and time the job is scheduled to run. null if the job is not scheduled to run again.
\n\n \n
\n\n
OwnerId\n
\n \n
Type
\n\n
reference
\n\n \n \n
Properties
\n\n
Filter, Group, Nillable, Sort
\n\n \n \n
Description
\n\n
Owner of the job.
\n\n \n
\n\n
PreviousFireTime\n
\n \n
Type
\n\n
dateTime
\n\n \n \n
Properties
\n\n
Filter, Nillable, Sort
\n\n \n \n
Description
\n\n
The most recent date and time the job ran. null if\n the job has not run before current local time.
\n\n \n
\n\n
StartTime\n
\n \n
Type
\n\n
dateTime
\n\n \n \n
Properties
\n\n
Filter, Nillable, Sort
\n\n \n \n
Description
\n\n
The date and time when the most recent iteration of the scheduled job started.
\n\n \n
\n\n
State\n
\n \n
Type
\n\n
string
\n\n \n \n
Properties
\n\n
Filter, Group, Nillable, Sort
\n\n \n \n
Description
\n\n
The current state of the job. The job state is managed by the system. Possible values are:
    \n
  • \nWAITING—The job is waiting for\n execution.
    • \n\n
  • \nACQUIRED—The job has been picked up by\n the system and is about to execute.
    • \n\n
  • \nEXECUTING—The job is executing.
    • \n\n
  • \nCOMPLETE—The trigger has fired and is\n not scheduled to fire again.
    • \n\n
  • \nERROR—The trigger definition has an\n error.
    • \n\n
  • \nDELETED—The job has been deleted.
    • \n\n
  • \nPAUSED—A job can have this state during\n patch and major releases. After the release has finished, the job state is\n automatically set to WAITING or another\n state.
    • \n\n
  • \nBLOCKED—Execution of a second instance\n of the job is attempted while one instance is running. This state lasts until the first\n job instance is completed.
    • \n\n
  • \nPAUSED_BLOCKED—A job has this state due\n to a release occurring. When the release has finished and no other instance of the job\n is running, the job’s status is set to another state.
    • \n\n
\n
\n\n \n
\n\n
TimesTriggered\n
\n \n
Type
\n\n
int
\n\n \n \n
Properties
\n\n
Filter, Group, Nillable, Sort
\n\n \n \n
Description
\n\n
The number of times this job has been triggered.
\n\n \n
\n\n
TimeZoneSidKey\n
\n \n
Type
\n\n
picklist
\n\n \n \n
Properties
\n\n
Filter, Group, Nillable, Restricted picklist, Sort
\n\n \n \n
Description
\n\n
Returns the timezone ID. For example, America/Los_Angeles.
\n\n \n
\n\n
\n\n
\n\n
\n

Usage

\n\n \n

Use this object to query scheduled jobs in your organization.

\n\n
\n\n
"}