pub struct Cycle {Show 30 fields
pub id: Option<String>,
pub created_at: Option<DateTime<Utc>>,
pub updated_at: Option<DateTime<Utc>>,
pub archived_at: Option<DateTime<Utc>>,
pub number: Option<f64>,
pub name: Option<String>,
pub description: Option<String>,
pub starts_at: Option<DateTime<Utc>>,
pub ends_at: Option<DateTime<Utc>>,
pub completed_at: Option<DateTime<Utc>>,
pub auto_archived_at: Option<DateTime<Utc>>,
pub issue_count_history: Option<Vec<f64>>,
pub completed_issue_count_history: Option<Vec<f64>>,
pub scope_history: Option<Vec<f64>>,
pub completed_scope_history: Option<Vec<f64>>,
pub in_progress_scope_history: Option<Vec<f64>>,
pub team: Option<Box<Team>>,
pub progress_history: Option<Value>,
pub current_progress: Option<Value>,
pub inherited_from: Option<Box<Cycle>>,
pub is_active: Option<bool>,
pub is_future: Option<bool>,
pub is_past: Option<bool>,
pub issues: Option<IssueConnection>,
pub uncompleted_issues_upon_close: Option<IssueConnection>,
pub progress: Option<f64>,
pub is_next: Option<bool>,
pub is_previous: Option<bool>,
pub documents: Option<DocumentConnection>,
pub links: Option<EntityExternalLinkConnection>,
}Expand description
A time-boxed iteration (similar to a sprint) used for planning and tracking work. Cycles belong to a team and have defined start and end dates. Issues are assigned to cycles for time-based planning, and progress is tracked via completed, in-progress, and total scope. Cycles are automatically completed when their end date passes, and uncompleted issues can be carried over to the next cycle.
Fields§
§id: Option<String>The unique identifier of the entity.
created_at: Option<DateTime<Utc>>The time at which the entity was created.
updated_at: Option<DateTime<Utc>>The last time at which the entity was meaningfully updated. This is the same as the creation time if the entity hasn’t been updated after creation.
archived_at: Option<DateTime<Utc>>The time at which the entity was archived. Null if the entity has not been archived.
number: Option<f64>The auto-incrementing number of the cycle, unique within its team. This value is assigned automatically by the database and cannot be set on creation.
name: Option<String>The custom name of the cycle. If not set, the cycle is displayed using its number (e.g., “Cycle 5”).
description: Option<String>The description of the cycle.
starts_at: Option<DateTime<Utc>>The start date and time of the cycle.
ends_at: Option<DateTime<Utc>>The end date and time of the cycle. When a cycle is completed prematurely, this is updated to match the completion time. When cycles are disabled, both endsAt and completedAt are set to the current time.
completed_at: Option<DateTime<Utc>>The completion time of the cycle. If null, the cycle has not been completed yet. A cycle is completed either when its end date passes or when it is manually completed early.
auto_archived_at: Option<DateTime<Utc>>The time at which the cycle was automatically archived by the auto-pruning process. Null if the cycle has not been auto-archived.
issue_count_history: Option<Vec<f64>>The total number of issues in the cycle after each day. Each entry represents a snapshot at the end of that day, forming the basis for burndown charts.
completed_issue_count_history: Option<Vec<f64>>The number of completed issues in the cycle after each day. Each entry corresponds to the same day index as issueCountHistory.
scope_history: Option<Vec<f64>>The total number of estimation points (scope) in the cycle after each day. Used for scope-based burndown charts.
completed_scope_history: Option<Vec<f64>>The number of completed estimation points after each day. Used together with scopeHistory for burndown charts.
in_progress_scope_history: Option<Vec<f64>>The number of in-progress estimation points after each day. Tracks work that has been started but not yet completed.
team: Option<Box<Team>>The team that the cycle belongs to. Each cycle is scoped to exactly one team.
progress_history: Option<Value>Internal The detailed progress history of the cycle, including per-status breakdowns over time.
current_progress: Option<Value>Internal The current progress snapshot of the cycle, broken down by issue status categories.
inherited_from: Option<Box<Cycle>>The parent cycle this cycle was inherited from. When a parent team creates cycles, sub-teams automatically receive corresponding inherited cycles.
is_active: Option<bool>Whether the cycle is currently active. A cycle is active if the current time is between its start and end dates and it has not been completed.
is_future: Option<bool>Whether the cycle has not yet started. True if the cycle’s start date is in the future.
is_past: Option<bool>Whether the cycle’s end date has passed.
issues: Option<IssueConnection>Issues that are currently assigned to this cycle.
uncompleted_issues_upon_close: Option<IssueConnection>Issues that were still open (not completed) when the cycle was closed. These issues may have been moved to the next cycle.
progress: Option<f64>The overall progress of the cycle as a number between 0 and 1. Calculated as (completed estimate points + 0.25 * in-progress estimate points) / total estimate points. Returns 0 if no estimate points exist.
is_next: Option<bool>Whether this cycle is the next upcoming (not yet started) cycle for the team.
is_previous: Option<bool>Whether this cycle is the most recently completed cycle for the team.
documents: Option<DocumentConnection>Internal Documents associated with the cycle.
links: Option<EntityExternalLinkConnection>Internal Links associated with the cycle.