Scheduler Model

Overview

Handles scheduling of automated jobs.

Fields

Field	Type	Description	Required
id	string	A unique identifier for the scheduler task	❌
application_id	string	The ID of the application where this task is being used or scheduled.	❌
cronId	string	A unique identifier for the cron job. Could be used by a third-party system or internal scheduler engine.	❌
cronName	string	A descriptive name for the cron job.Useful for UI or logs.	❌
timeExpression	string	The actual cron expression defining when the job runs.	❌
expressionName	string	A readable name for the cron expression	❌
taskFunctionData	object	Serialized or JSON data containing the parameters or payload for the function/task.	❌
taskFunction	string	Name or path of the function to be executed by the scheduler.	❌
type	string	Defines the type of scheduler task.Can help filter or group tasks.	❌
status	string	The current status of the scheduler	❌
timeZone	string	Specifies the time zone for the cron job execution. Ensures correct time-based execution globally.	❌
objectName	string	Name of the target object this task is associated with.	❌
objectId	string	ID of the target object the task is related to.	❌
userId	string	The user who created or owns the scheduler task. May be used for access control or history tracking.	❌
org_id	string	Links the scheduler task to a specific organization.	❌
sites_id	string	Links the scheduler to a specific site.	❌
userData	object	Stores user-related data	❌
jobs	any	Stores details about scheduled jobs	❌
created_at	date	Timestamp when the scheduler task was created	❌
modified_at	date	The timestamp when the scheduler task was last updated. Useful for tracking changes to job configs.	❌
dotNetServerEndpointUrl	string	The API endpoint for executing the scheduled task.	❌
statusURL	string	A URL to check the execution status of the scheduled job.	❌
cronType	string	Type of cron used (e.g., standard, quartz, custom). Useful if different parsers/schedulers are supported.	❌
options	any	Additional config or flags (as JSON or key-value pairs) used to customize execution.	❌
dataPackId	string	Links this task to a particular dataset or package of information, possibly used in exports/imports.	❌

Sample JSON

{
  "id": "example_value",
  "application_id": "example_value",
  "cronId": "example_value",
  "cronName": "example_value",
  "timeExpression": "example_value",
  "expressionName": "example_value",
  "taskFunctionData": "example_value",
  "taskFunction": "example_value",
  "type": "example_value",
  "status": "example_value",
  "timeZone": "example_value",
  "objectName": "example_value",
  "objectId": "example_value",
  "userId": "example_value",
  "org_id": "example_value",
  "sites_id": "example_value",
  "userData": "example_value",
  "jobs": "example_value",
  "created_at": "example_value",
  "modified_at": "example_value",
  "dotNetServerEndpointUrl": "example_value",
  "statusURL": "example_value",
  "cronType": "example_value",
  "options": "example_value",
  "dataPackId": "example_value"
}