Data Integration
- Data Integration
- All Products
/public/core/v3/schedule/<id>
Field
| Type
| Required
| Description
|
---|---|---|---|
name
| String
| -
| Schedule name.
|
id
| String
| Yes
| Schedule ID.
You cannot update the schedule ID.
|
scheduleFederatedId
| String
| Yes
| Global unique identifier for the schedule.
You cannot update the federated schedule ID.
|
description
| String
| -
| Description of the schedule.
|
status
| String
| -
| Status of the schedule. Use one of the following values:
Default is enabled.
|
startTime
| Date/time
| -
| Date and time when the schedule starts running the tasks, in UTC format.
|
endTime
| Date/time
| -
| Date and time when the schedule stops running the tasks. If you do not use this parameter, the schedule runs indefinitely.
|
interval
| String
| -
| Interval or repeat frequency at which the schedule runs tasks. Use one of the following options:
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.
Default is no interval.
|
frequency
| Int
| -
| Repeat frequency for tasks. Use one of the following values:
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, Weekly, and Biweekly 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
| Boolean
| -
| Runs tasks on weekdays. Use one of the following options:
Use with the Daily interval only.
|
dayOfMonth
| Int
| -
| 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:
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:
Use with the Monthly interval only.
|
timeZoneId
| String
| -
| Time zone that the schedule uses for the dayOfMonth, weekOfMonth, and dayOfWeek fields.
Default is UTC.
For more information, see Appendix A,
Time zone codes
|
PATCH <baseApiUrl>/public/core/v3/schedule/0An1v84VPL3k6kypOlxq06D0000000000003 Accept: application/json INFA-SESSION-ID: <sessionId> { "schedules": [ { "id": "0An1v84VPL3k6kypOlxq06D0000000000003", "scheduleFederatedId": "1KiAwzRVIOTlAtCjPtzV4H", "name": "V3_Test_CreateSchedule_1569944878", "status": "disabled", "description": "Update version 2", "sat": true } ] }
{ "id": "0An1v84VPL3k6kypOlxq06D0000000000003", "createTime": "2022-09-24T15:34:36.000Z", "updateTime": "2022-10-01T15:47:59.442Z", "createdBy": "dev_larry", "updatedBy": "dev_larry", "name": "V3_Test_CreateSchedule_1569944878", "rangeStartTime": null, "rangeEndTime": null, "status": "disabled", "frequency": 1, "description": "Update version 2", "mon": false, "tue": false, "wed": true, "thu": false, "fri": false, "sat": true, "sun": false, "weekDay": false, "dayOfMonth": 0, "weekOfMonth": null, "dayOfWeek": null, "scheduleFederatedId": "1KiAwzRVIOTlAtCjPtzV4H", "startTime": "2022-12-25T12:00:00.000Z", "endTime": null, "interval": "Hourly", "timeZoneId": "America/Los Angeles" }