Schedule

Use this resource to request the details of a schedule or the details of all schedules in the organization. You can create or update a schedule. You can also delete a schedule.

GET Request

To view the details of all schedules in the organization, use the following URI:

/api/v2/schedule

To request the details of a particular schedule, you can include the schedule ID or schedule name in the URI. Use one of the following URIs:

/api/v2/schedule/<id>
/api/v2/schedule/name/<name>

If you use the schedule name in the URI and the schedule name includes a space, replace the space with %20. For example:

/api/v2/schedule/name/my%20schedule

GET Response

If successful, returns the schedule object for the requested schedule. Or, if you request the details for all schedules, returns the schedule object for each schedule in the organization.
Returns the error object if errors occur.
The schedule object includes the following attributes:

Field

Type

Description

id

String

Schedule ID.

orgId

String

Organization ID.

name

String

Schedule name.

description

String

Description of the schedule.

createTime

Date/time

Time the schedule was created.

updateTime

Date/time

Last time the schedule was updated.

createdBy

String

User who created the schedule.

updatedBy

String

User who last updated the schedule.

startTime

Date/time

Date and time when the schedule starts running.

startTimeUTC

Date/time

Date and time when the schedule starts running. Uses Coordinated Universal Time (UTC).

endTime

Date/time

Date and time when the schedule stops running.

interval

String

Interval or repeat frequency at which the schedule runs. Returns one of the following codes:
None. The schedule does not repeat.
Minutely. Tasks run on an interval based on the specified number of minutes, days, and time range.
Hourly. Tasks run on an hourly interval based on the start time of the schedule.
Daily. Tasks run daily at the start time configured for the schedule.
Weekly. Tasks run on a weekly interval based on the start time of the schedule.
Monthly. Tasks run on a monthly interval based on the start time of the schedule.

frequency

int

Frequency that the schedule runs. Returns a numeric value that represents one of the following:
For Minutely intervals: tasks run every n minutes.
For Hourly intervals: tasks run every n hours.
Minutely and Hourly intervals only.

rangeStartTime

Date/time

The start of the time range within a day that tasks run. Minutely and Hourly intervals only.

rangeEndTime

Date/time

The end of the time range within a day that tasks run. Minutely and Hourly intervals only

sun

Boolean

Tasks run on Sunday. Returns one of the following codes:
true
false
Minutely, Hourly, and Weekly intervals only.

mon

Boolean

Tasks run on Monday. Returns one of the following codes:
true
false
Minutely, Hourly, and Weekly intervals only.

tue

Boolean

Tasks run on Tuesday. Returns one of the following codes:
true
false
Minutely, Hourly, and Weekly intervals on

wed

Tasks run on Wednesday. Returns one of the following codes:
true
false
Minutely, Hourly, and Weekly intervals only

thu

Boolean

Tasks run on Thursday. Returns one of the following codes:
true
false
Minutely, Hourly, and Weekly intervals only

fri

Boolean

Tasks run on Friday. Returns one of the following codes:
true
false
Minutely, Hourly, and Weekly intervals only.

sat

Boolean

Tasks run on Saturday. Returns one of the following codes:
true
false
Minutely, Hourly, and Weekly intervals only

weekDay

Boolean

Tasks run on weekdays only. Returns one of the following codes:
true
false
Daily interval only.

dayOfMonth

int

Date of the month that tasks run. Returns a date between 1-28.
Monthly interval only.

weekOfMonth

String

Week of the month that tasks run. Returns one of the following codes:
First. The tasks run in the first week of the month.
Second. The tasks run in the second week of the month.
Third. The tasks run in the third week of the month.
Fourth. The tasks run in the fourth week of the month.
Last. The tasks run in the last week of the month.
Monthly interval only.

dayOfWeek

String

Day of the week that tasks run. Returns one of the following codes:
Day. Tasks run on the first day or last day of the month, based on the selected weekOfMonth option.
Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Monthly interval only

timeZone

String

Time zone of the user who last updated the schedule. Time zone honors Daylight Saving Time.

POST Request

To update a schedule, use the schedule ID with the following URI. To create a schedule, omit the optional schedule ID.

/api/v2/schedule/<id>

You can submit a partial update using partial mode. To submit a request using partial mode, use a JSON request and include the following line in the header:

Update-Mode=PARTIAL

You can use the following attributes in a schedule object:

Field

Type

Required

Description

id

String

Required for updates only

Schedule ID.

orgId

String

Yes

Organization ID.

name

String

Yes

Schedule name.

description

String

Description of the schedule.

startTime

Date/time

Yes

Date and time when the schedule starts running.

startTimeUTC

Date/time

Yes

Date and time when the schedule starts running. Uses Coordinated Universal Time (UTC).

endTime

Date/time

Date and time when the schedule stops running. If you do not use this parameter, the schedule runs indefinitely.

interval

String

Yes

Interval or repeat frequency at which the schedule runs. Use one of the following options:
None. Tasks run at the schedule start time. The schedule does not repeat.
Minutely. Tasks run on an interval based on the specified number of minutes, days, and time range. You can use the following parameters:
frequency. Frequency in minutes that tasks run.
sun, mon, tue, wed, thu, fri, sat. The days of the week that tasks run.
startTimeRange and endTimeRange. The time range within a day tasks should run. Do not use if you want tasks to run all day.
endTime. When the schedule should stop running. Do not use if you want the schedule to run indefinitely.
Hourly. Tasks run on an hourly interval based on the start time of the schedule. You can use the following parameters:
frequency. Frequency in hours that tasks run.
sun, mon, tue, wed, thu, fri, sat. The days of the week that tasks run.
startTimeRange and endTimeRange. The time range within a day tasks should run. Do not use if you want tasks to run all day.
endTime. When the schedule should stop running. Do not use if you want the schedule to run indefinitely.
Daily. Tasks run daily at the start time configured for the schedule. You can use the following parameters:
weekDay. Runs the tasks every weekday. Do not use if you want the tasks to run every day.
endTime. When the schedule should stop running. Do not use if you want the schedule to run indefinitely.
Weekly. Tasks run on a weekly interval based on the start time of the schedule. You can use the following parameters:
sun, mon, tue, wed, thu, fri, sat. The days of the week that tasks run.
endTime. When the schedule should stop running. Do not use if you want the schedule to run indefinitely.
Monthly. Tasks run on a monthly interval based on the start time of the schedule. You can use the following parameters:
dayOfMonth. Day of the month when you want tasks to run, between 1-28.
dayOfWeek. Day of the week when you want tasks to run.
weekOfMonth. Week of the month when you want tasks to run.
endTime. When the schedule should stop running. Do not use if you want the schedule to run indefinitely.
To indicate when tasks should run, use dayOfWeek with weekOfMonth, such as the First Monday. Or use dayOfMonth, such as 1.
Tip: To run tasks on the last day of the month, use the Last weekOfMonth parameter with the Day dayOfWeek parameter.

frequency

Int

Repeat frequency for tasks. Use one of the following values:
For the Minutely interval, use one of the following options: 5, 10, 15, 20, 30, 45.
For the Hourly interval, use one of the following options: 1, 2, 3, 4, 6, 8, 12.
Use with Minutely and Hourly intervals only.

rangeStartTime

Date/time

The start of the time range within a day that you want tasks to run. Enter a date and time using standard date/time format. Only the time portion is used.
Use with Minutely and Hourly intervals only.

rangeEndTime

Date/time

The end of the time range within a day that you want tasks to run. Enter a date and time using standard date/time format. Only the time portion is used.
Use with Minutely and Hourly intervals only.

sun

Boolean

Runs tasks on Sunday at the configured time.
You can use the sun - sat parameters to run tasks on several days of the week.
Use with Minutely, Hourly, and Weekly intervals only.

mon

Boolean

Runs tasks on Monday at the configured time.
See description for sun.

tue

Boolean

Runs tasks on Tuesday at the configured time.
See description for sun.

wed

Boolean

Runs tasks on Wednesday at the configured time.
See description for sun

thu

Boolean

Runs tasks on Thursday at the configured time.
See description for sun

fri

Boolean

Runs tasks on Friday at the configured time.
See description for sun

sat

Boolean

Runs tasks on Saturday at the configured time.
See description for sun

weekDay

Int

Runs tasks on weekdays. Use one of the following options:
True. Run tasks on Monday through Friday. Does not run tasks on the weekend.
False. Run tasks every day.
Use with the Daily interval only.

dayOfMonth

String

Date of the month that tasks should run. Use a date between 1-28.
Use with the Monthly interval only.
Tip: To run tasks on the last day of the month, use the Last weekOfMonth parameter with the Day dayOfWeek parameter

weekOfMonth

String

Week of the month that tasks should run. Use with dayOfWeek to specify the day and week of the month that tasks should run. For example, the First Day or the Last Wednesday of the month.
Use one of the following options:
First
Second
Third
Fourth
Last
Use with the Monthly interval only.

dayOfWeek

String

Day of the week that tasks should run. Use with weekOfMonth to specify the day and week of the month that tasks should run. For example, the First Day or the Last Wednesday of the month.
Use one of the following options:
Day
Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Use with the Monthly interval only.

timeZone

String

Time zone to use for the schedule. If no valid time zone is passed, Informatica Intelligent Cloud Services uses the user's time zone.
For more information, see Appendix A, Time zone codes

POST Response

Returns the schedule response object for the schedule that you created or updated.
Returns an error object if errors occur

DELETE Request

To delete a schedule, use the schedule ID with the following URI:

/api/v2/schedule/<id>

DELETE Response

Returns the 200 response code if the request is successful.
Returns an error object if errors occur.

GET Example

To request information about all schedules in the organization, you might use the following request:

GET <serverUrl>/api/v2/schedule
   Accept: application/json
   icSessionId: <icSessionId>

A successful request returns a schedule object for each schedule in the organization.