schedule_instantiate_response object contains information on the target dates for each job instantiated from a given schedule using the instantiate call.
schedule_instantiate_response object is returned for each schedule provided in the request.
|custom||custom||User-supplied custom fields that are returned unmodified in the response.|
|id||id||The ID of the schedule that was provided in the request.|
|jobs||schedule_job_response||Information on the jobs that have been instantiated from this schedule. Jobs that were included in the request are not included here.|
|name||string||The name of the schedule that was provided in the request.|
schedule_job_response object encapsulates a single job instantiated from a schedule.
|job||id||The ID of the instantiated job. The full job object is contained in response.jobs.|
|ordinal||integer||The ordinal of this job in its schedule's jobs.|
|target_date||date||The target date of this job instance. If no base_date was set on the schedule, no target date is returned.|
|target_date_range||date_range||The range of allowed dates that this job can be assigned to.|
target_date_range field represents the range of allowed dates that a given job instance can be delivered on.
If a base_date was provided, the
target_date_range is provided by the instance target_date,
along with any variance specified with allowed_variance_before and allowed_variance_after.
If no base date was provided, the
target_date_range is calculated using the range of possible base dates that could be chosen for the given instance.
For example, if a weekly schedule has an earliest_date of
0has a target date range of
1has a target date range of
2has a target date range of
- Instantiating Routes.
- The instantiate endpoint.
- The instantiate_response type.