IterationCadence
A schedule that generates a group's iterations, keeping the next few always created.
Shape
- activebooleanWhether it generates iterations. A paused cadence generates nothing and keeps what it made.
- cadence_idCadenceId (string · uuid)The cadence's identifier.
- cool_down_weeksinteger · int320–∞Weeks left between one iteration's end and the next one's start, which belong to no iteration: 0 to 4. Shape Up's cool-down between cycles.
- created_atstringWhen it was created, ISO 8601.
- duration_weeksinteger · int320–∞How long each iteration runs, in weeks: 1 to 12.
- first_start_dateCalendarDate (string)The date the schedule starts from. The first iteration begins on the first
start_dayon or after it. - generated_throughinteger · int320–∞The number of the last iteration it has generated, or 0 before the first.
- group_idGroupId (string · uuid)The group whose iterations it generates.
- iterations_in_advanceinteger · int320–∞How many upcoming iterations are kept created ahead of today: 1 to 12.
- start_dayWeekdaymondaytuesdaywednesdaythursdayfridaysaturdaysundayThe weekday every iteration begins on.
- titleCadenceTitle (string)Its title. Each iteration it generates is titled with it and the iteration's number.
- updated_atstringWhen it last changed, ISO 8601.
Example
Synthesized example{
"active": true,
"cadence_id": "c0a14112-9166-4a2d-b3fc-136c842607c9",
"cool_down_weeks": 62,
"created_at": "2026-10-10T14:38:53Z",
"duration_weeks": 11,
"first_start_date": "first-start-date-6805",
"generated_through": 6,
"group_id": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69",
"iterations_in_advance": 18,
"start_day": "monday",
"title": "Stream pipeline status into the run header",
"updated_at": "2026-10-17T00:29:57Z"
}
Graph
Used inside
No schema contains this one.
Contains
No named schema inside.
Used by
Sent by 0 operations
No operation takes it as a request body.
Returned by 4 operations
- GETList a group's iteration cadences/groups/{group_id}/iteration-cadences
- POSTCreate an iteration cadence/groups/{group_id}/iteration-cadences
- GETGet an iteration cadence/groups/{group_id}/iteration-cadences/{cadence_id}
- PATCHUpdate an iteration cadence/groups/{group_id}/iteration-cadences/{cadence_id}