Skip to main content

Cronjobs Model

Overview​

The cronjobs table stores the configuration and execution details for scheduled cron jobs within a system. It includes fields to define the job's schedule, associated functions, task parameters, and metadata related to job execution.

Fields​

FieldTypeDescriptionRequired
idstringPrimary Key – Unique identifier for the cron job (UUID).❌
cronIdstringUnique identifier for the cron job. This can be used for referencing or retrieving the job details.✅
cronNamestringThe name of the cron job, used for identification and easy reference.✅
timeExpressionstringThe cron time expression that defines the schedule for the job.✅
expressionNamestringName or description of the time expression, possibly for readability or specific use cases.✅
taskFunctionDataobjectAdditional data related to the function that will be executed, such as parameters or configuration.❌
userDataanyData related to the user that triggered or owns the job, which could include user-specific parameters or configuration.❌
taskFunctionstringThe function or task that will be executed by the cron job.❌
typestringThe type of the cron job (e.g., batch, API call, cleanup).❌
statusstringThe current status of the cron job (e.g., active, inactive, completed).❌
timeZonestringThe time zone in which the cron job is scheduled to run.❌
objectNamestringThe name of the object associated with the cron job (e.g., "backup", "reporting").✅
buildTypestringType or version of the build the cron job belongs to (if applicable).❌
package_typestringThe type of package or deployment the cron job is associated with.❌
objectIdstringUnique identifier for the object associated with the cron job.❌
parentProviderstringThe parent provider associated with the cron job (e.g., cloud provider, service).❌
providerstringThe provider that will execute the cron job (e.g., server name, cloud service).❌
customInputsstringCustom input parameters for the cron job, which may modify its behavior.❌
dataPackIdstringID for the associated data pack, used if the cron job works with data packs.❌
application_idstringThe ID of the application associated with the cron job.❌
org_idstringThe organization ID associated with the cron job.❌
sites_idstringThe site ID associated with the cron job.❌
scheduler_typestringThe type of scheduler (e.g., internal, external, cron-based).❌
isDebugEnabledbooleanWhether debugging is enabled for the cron job (0 = disabled, 1 = enabled).❌
created_atdateTimestamp when the cron job was created.❌
modified_atdateTimestamp when the cron job was last modified.❌
job_typeanyDescription or type of job to be executed (e.g., "backup", "data sync").❌
workflow_action_idanyID for the workflow action associated with the cron job.❌

Relationships​

  • Belongsto Unknown
  • Belongsto Unknown

Sample JSON​

{
"id": "example_value",
"cronId": "example_value",
"cronName": "example_value",
"timeExpression": "example_value",
"expressionName": "example_value",
"taskFunctionData": "example_value",
"userData": "example_value",
"taskFunction": "example_value",
"type": "example_value",
"status": "example_value",
"timeZone": "example_value",
"objectName": "example_value",
"buildType": "example_value",
"package_type": "example_value",
"objectId": "example_value",
"parentProvider": "example_value",
"provider": "example_value",
"customInputs": "example_value",
"dataPackId": "example_value",
"application_id": "example_value",
"org_id": "example_value",
"sites_id": "example_value",
"scheduler_type": "example_value",
"isDebugEnabled": "example_value",
"created_at": "example_value",
"modified_at": "example_value",
"job_type": "example_value",
"workflow_action_id": "example_value"
}