project_iteration_cadences

Gets or lists a project_iteration_cadences resource.

Overview

Name	project_iteration_cadences
Type	Resource
Id	gitlab.projects.project_iteration_cadences

Fields

The following fields are returned by SELECT queries:

list

GraphQL response envelope

Name	Datatype	Description
id	string	Global ID of the iteration cadence.
active	boolean	Whether the iteration cadence is active.
automatic	boolean	Whether the iteration cadence should automatically generate upcoming iterations.
description	string	Description of the iteration cadence. Maximum length is 5000 characters.
duration_in_weeks	integer	Duration in weeks of the iterations within the cadence.
iterations_in_advance	integer	Number of future iterations to schedule in addition to the current one.
roll_over	boolean	Whether the iteration cadence should roll over issues to the next iteration or not.
start_date	string	Timestamp of the automation start date.
title	string	Title of the iteration cadence.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	full_path, host	active, automatic, duration_in_weeks, id, include_ancestor_groups, title	Find iteration cadences. Generated from the GitLab GraphQL schema field Project.iterationCadences (connection of IterationCadence nodes).

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
full_path	string	Full path of the project, for example gitlab-org/gitlab
host	string	GitLab host, with an optional port (default gitlab.com). Resolved from the GITLAB_HOST environment variable when it is set (x-stackQL-envVar); a WHERE host value always takes precedence. Self-managed instances: the provider is generated from the gitlab.com schema, so older instances may reject fields they do not serve. (default: gitlab.com, x-stackQL-envVar: GITLAB_HOST)
active	boolean	Whether the iteration cadence is active.
automatic	boolean	Whether the iteration cadence should automatically generate upcoming iterations.
duration_in_weeks	integer	Duration in weeks of the iterations within the cadence.
id	string	Global ID of the iteration cadence to look up.
include_ancestor_groups	boolean	Whether to include ancestor groups to search iterations cadences in.
title	string	Fuzzy search by title.

SELECT examples

list

Find iteration cadences. Generated from the GitLab GraphQL schema field Project.iterationCadences (connection of IterationCadence nodes).

SELECT
id,
active,
automatic,
description,
duration_in_weeks,
iterations_in_advance,
roll_over,
start_date,
title
FROM gitlab.projects.project_iteration_cadences
WHERE full_path = '{{ full_path }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
AND active = '{{ active }}'
AND automatic = '{{ automatic }}'
AND duration_in_weeks = '{{ duration_in_weeks }}'
AND id = '{{ id }}'
AND include_ancestor_groups = '{{ include_ancestor_groups }}'
AND title = '{{ title }}'
;