CreateIterationCadenceRequest
A cadence: the schedule its iterations follow and how far ahead they are created.
Shape
- first_start_dateCalendarDate (string)The date the schedule starts from. The first iteration begins on the first start day on or after it.
- titleCadenceTitle (string)Its title. Each iteration it generates is titled with it and the iteration's number.
- activeboolean or nulloptionalWhether it starts generating straight away. Defaults to true.
- cool_down_weeksinteger · int32 or nulloptional0–∞Weeks left between iterations that belong to none: 0 to 4. Defaults to 0.
- duration_weeksinteger · int32 or nulloptional0–∞How long each iteration runs, in weeks: 1 to 12. Defaults to 2.
- iterations_in_advanceinteger · int32 or nulloptional0–∞How many upcoming iterations to keep created ahead of today: 1 to 12. Defaults to 4.
- start_dayWeekdaymondaytuesdaywednesdaythursdayfridaysaturdaysundayor nulloptionalThe weekday iterations begin on. Defaults to Monday.
Example
Synthesized example{
"first_start_date": "first-start-date-7070",
"title": "Pin a page's payload to the build that rendered it",
"active": true,
"cool_down_weeks": 29,
"duration_weeks": 11,
"iterations_in_advance": 18,
"start_day": "monday"
}
Graph
Used inside
No schema contains this one.
Contains
No named schema inside.
Used by
Sent by 1 operation
Returned by 0 operations
No operation returns it directly.