Job - addOneTimeScheduleWithEMailNotification

Job - addOneTimeScheduleWithEMailNotification

Description :

This command adds a one-time schedule to a job and, depending on the resulting status of the job run, issues an email notification. If approval is enabled for the job type, use the addOneTimeScheduleWithEMailNotificationAndWithApproval command instead.

The argument jobKey is a handle to the job being modified. To find the jobKey for a specific job type, use the SnapshotJob getDBKeyByGroupAndName command.

The dateString argument defines a one-time schedule to be added. It must be in the format YYYY-MM-DD HH:MM:SS.

The recipient argument identifies the receiver of the email that this command generates. The statusType argument determines the statuses for which you want to issue a notification. The possible statuses each have a value as follows:

• Success=2
• Failure=4
• Cancel=8

For statusType, add the statuses for which you want to issue notifications. For example, if you want to issue notifications when the job status is Failure or Cancel, then statusType=12.

Return type : java.lang.Object

Command Input :

Example

The following example shows how to add a schedule to a job for a single run on the 1st of January 2005 at 11:35 PM. Email will be sent on success, failure, or cancel.

Script