Fields and Values Reference

Fields and Values Reference

You need to understand the specific object fields and their values when making RESTful requests to work scheduled jobs in Telerik Platform.

Use the information in this article to complement the instructions in the rest of the articles about scheduled jobs. It includes the following reference information:

Scheduled Job Object Fields

The next table represents the scheduled job object as saved in Telerik Platform. Note that not all fields are user-editable.

Field Type Description
Name String A human-friendly name of the scheduled job. Can contain only Latin alphabetic and numeric characters. Cannot contain white spaces. Cannot start with a number.
CloudFunctionId GUID The Id of the cloud function to be scheduled.
Recurrence Object An object representing the recurrence pattern.
Recurrence.Type Number Together with Recurrence.Interval specifies how often the job is to be executed. 0=once (Interval and Day values are ignored), 1=minutes, 2=hours, 3=days, 4=weeks, 5=months.
Example: To set the job to execute once every 4 hours, set Type=2, Interval=4.
Recurrence.Interval Number Specifies how often per Recurrence.Type the job is to be executed. Ignored if Recurrence.Type=0.
Example: To set the job to execute once every 4 hours, set Type=2, Interval=4.
Recurrence.Day Number Specifies day of week (0[Sun]-6[Sat]) or day of month (1-31) on which the job is to recur. Only applicable when Recurrence.Type=4 or 5.
StartDate Date Date of the first execution in ISO 8601 format. The time part, if specified, is ignored. Once set, this field cannot be updated.
StartTime Number Time of the first execution in minutes from the start of the day (00:00) specified with StartDate.
EndType Number Ending criterion: 1=recur forever, 2=number of occurrences, 3=end date. Required if Recurrence.Type is not equal to 0.
EndValue Number or Date Ending value. Can be used only in conjunction with EndType. If EndType=2, specifies the number of occurrences after which the job will no longer execute. If EndType=3, specifies a date-time value in ISO 8601 format after which the job will no longer execute.
IsEnabled Boolean Disables or enables the job. When you enable a job that has skipped a number of executions due to being disabled, it runs immediately.
State Number Read-only system field Indicates the scheduled job's current state. See State Field Values for more information.
Stats Object Read-only system field Provides statistical data about job executions. See Stats Field Values for more information.
LastOccurrence Object Read-only system field Provides information about the last execution given that the job has already had at least one execution. See LastOccurrence Field Values for more information.

State Field Values

The next table represents the State object that is part of the scheduled job object. Note that none of the fields are editable.

Value Description
1 Active. When a job is scheduled it immediately enters this state.
2 Completed. Means that the job has no future occurrences.
3 Suspended. The job will enter this state if it has accumulated 10 unsuccessful executions (timeouts or fails).

Stats Field Values

The next table represents the Stats object that is part of the scheduled job object. It provides related statistical information.

Keep in mind that the TimeoutsCount and FailedCount fields are reset after a successful run of the task.

Name Value Description
ExecutionsCount Number The total count of completed executions—successful, timed out, or failed. The update operation does not reset this count.
TimeoutsCount Number How many times the execution resulted in a timeout.
FailedCount Number How many times the execution resulted in a failure. Failures occur when the Cloud Function returns an error.

LastOccurrence Field Values

The next table represents the LastOccurrence object that is part of the scheduled job object. It provides execution time and execution duration information.

Name Value Description
ExecutedFor Number How long (in milliseconds) it took for the job to finish.
ExecutedAt Date The specific moment in time when the last run of the job started.

See Also

Start a free trial Request a demo
Contact us: +1-888-365-2779
sales@telerik.com
Copyright © 2016-2017, Progress Software Corporation and/or its subsidiaries or affiliates. All rights reserved.