API: HTTP Show Scheduled Tasks
The Show Scheduled Tasks command allows you to return a list of tasks scheduled in the calendar for a certain range of days from a date. The command requires the following arguments: Command, Realm, Password, Start Date, and Range of Days.
api_web?r=myrealm&p=mypass&c=show_calendar&start_datetime=03-01-2017&range=7
The command is ‘show_calendar’, the realm is ‘myrealm’, the password is ‘mypass’ and will return scheduled tasks that are scheduled starting on March 1, 2017 until March 7, 2017.
Example
Using all commands and arguments (please note the command is wrapped for display purposes only):
api_web?c=show_calendar&r=myrealm&p=mypass&start_datetime=02-22-2017&range=1&output_format=csv&headers=1
Successful results return:
Type,Description,Frequency,Repeat Days,Last Run,Next Run Date,Next Run Time
Event Report,Run Event Report My Event report,Weekly,Wed,02-15-2017 04:42:00 AM,02-22-2017,04:42:00 AM
Custom Report,Run Custom Report My Custom Report,Daily,Wed,02-15-2017 06:13:00 AM,02-22-2017,06:13:00 AM
Domain Report,Run Domain Report My Domain Report Name,Weekly,Sun/Wed,02-15-2017 07:29:00 AM,02-22-2017,07:29:00 AM
Publish,Publish My List (My Template),Once,Wed,N/A,02-22-2017,12:41:00 PM
Campaign Report,Run Campaign Report My Hourly Campaign Report,Hourly,Wed,N/A,02-22-2017,12:55:00 PM
Bounce Statistics Report,Bounce Statistics Report,Once,Wed,N/A,02-22-2017,01:01:00 PM
Results
The Show Optout command outputs either the results of the search or a FAILURE message.
SUCCESS
The Show Optout command does not explicitly return a Success code. Instead, it outputs the Task details in plain text format. Use the output_format argument to return the results in an alternate format.
The Task Details include the following:
|
Type Description |
Type of Task to run, and then Description:
|
| Frequency | Once, Daily, Weekly, Monthly |
| Repeat Days | List of Weekdays to repeat, in the shorted three character format separated by '/', for example Sun/Mon/Wed |
| Last Run | Date and Time Task last run if recurring in format mm-dd-yyyy hh:MM:ss AM/PM. If not run previously, then displayed as N/A. |
| Next Run Date | Date to next run Task in format mm-dd-yyyy |
| Next Run Time | Time to next run Task in format hh:MM:ss AM/PM |
FAILURE
A Show Optout command will fail for several reasons, such as if the campaign doesn't exist. The result format is:
FAILURE: [Reason]
Arguments
The Show Scheduled Tasks command supports the following arguments:
|
Name |
Req? |
Description |
Argument |
|
Command |
Yes |
Defines the command to use. |
cmd=show_calendar c=show_calendar |
|
Realm |
Yes |
Name of the realm to run the command. This is required, and the command will fail if the realm and password do not match. |
realm=[realm_name] r=[realm_name] |
|
Password |
Yes |
Authentication code for API access. This is required, and the command will fail if the realm and password do not match. |
pwd=[password] p=[password] |
|
Start Date |
Yes |
Date from which to display events. Date cannot be in the past. Date format is mm-dd-yyyy. |
start_datetime=[mm-dd-yyyy] |
| Range | Yes |
Specify a number of days to include in results. For example, to see all tasks scheduled for the next seven days, use the number '7' | range=[1-7] |
|
Output Format |
|
To specify the format of the list output, use one of two arguments. If no argument is included, the default output is space-delimited plain text string, which may not include all data columns. |
csv=1 or output_format=[csv,csv_tab, csv_pipe,xml] |
|
Header |
| To define the data with a label, use the Header argument. This can only be used in conjunction with the output format, and does not affect XML. |
headers=[0,1] DEFAULT==0 |
*Feature added in v12.06.0