ScheduledJob

Last update: November 11, 2022

CREATED FOR:

  • Developer
  • Admin

A job that is scheduled to run.

Syntax

Parameters

NameTypeDescription
companyHandlexsd:stringCompany handle.
jobHandlexsd:stringScheduled job handle.
namexsd:stringJob name.
originalNamexsd:stringOriginal name of the scheduled job.
typexsd:stringJob type.
submitUserEmailxsd:stringThe email address of the user who scheduled the job.
localexsd:stringThe locale to be used for job log details and email localization. Locales are specified as <language_code>[- <country_code>], where the language code is a lower-case, two-letter code as specified by ISO-639, and the optional country code is an upper-case, two-letter code as specified by ISO-3166. For example, the locale string for English (United States) would be: en-US.
descriptionxsd:stringA description of the job as originally specified in submitJob.
execSchedulexsd:stringWhen the job is scheduled to run.
nextFireTimexsd:dateTimeThe date, time, and time zone when the job is fired.
timeZonexsd:dateTimeThe time zone of the scheduled job.
triggerStatexsd:intChoice of job trigger state.
imageServingPublishJobtypes:ImageServingPublishJobJob details for an image serving publish job.
imageServingRenderJobtypes:ImageServingRenderJobJob details for an image rendering job.
videoPublishJobtypes:VideoPublishJobJob details for a video publish job. See VideoPublishJob.
serverDirectoryPublishJobtypes:ServerDirectoryPublishJobJob details for a server directory publish job.
uploadDirectoryJobtypes:UploadDirectoryJobJob details for an upload directory job.
uploadUrlsJobtypes:UploadUrlsJobJob details for an upload URLs job.
optimizeImagesJobtypes:OptimizeImagesJob
ripPdfsJobtypes:RipPdfsJob
reprocessAssetsJobtypes:ReprocessAssetsJob
exportJobtypes:ExportJobAllow authorized export of previously uploaded files. See Export Job.

Notes

When you specify a job type value in submitJob, the system returns a job based on that type. The following jobs can be returned:

  • imageServingPublishJob
  • imageRenderingPublishJob
  • videoPublishJob
  • serverDirectoryPublishJob
  • uploadDirectorhJob
  • uploadUrlsJob

Experience Manager