group_iterations

Gets or lists a group_iterations resource.

Overview

Name	group_iterations
Type	Resource
Id	gitlab.groups.group_iterations

Fields

The following fields are returned by SELECT queries:

list

GraphQL response envelope

Name	Datatype	Description
id	string	ID of the iteration.
created_at	string	Timestamp of iteration creation.
description	string	Description of the iteration.
due_date	string	Timestamp of the iteration due date.
group_	object	Group identity (id, full_path, name)
iid	string	Internal ID of the iteration.
scoped_path	string	Web path of the iteration, scoped to the query parent. Only valid for Project parents. Returns null in other contexts.
scoped_url	string	Web URL of the iteration, scoped to the query parent. Only valid for Project parents. Returns null in other contexts.
sequence	integer	Sequence number for the iteration when you sort the containing cadence's iterations by the start and end date. The earliest starting and ending iteration is assigned 1.
start_date	string	Timestamp of the iteration start date.
state	string	State of the iteration. (upcoming, current, opened, closed, all)
title	string	Title of the iteration.
updated_at	string	Timestamp of last iteration update.
web_path	string	Web path of the iteration.
web_url	string	Web URL of the iteration.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	full_path, host	id, iid, include_ancestors, include_descendants, search, sort, state	Find iterations. Generated from the GitLab GraphQL schema field Group.iterations (connection of Iteration 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 group, for example gitlab-org
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)
id	string	Global ID of the Iteration to look up.
iid	string	Internal ID of the Iteration to look up.
include_ancestors	boolean	Whether to include ancestor iterations. Defaults to true.
include_descendants	boolean	Whether to include descendant iterations.
search	string	Query used for fuzzy-searching in the fields selected in the argument in. Returns all iterations if empty.
sort	string	List iterations by sort order. If unspecified, an arbitrary order (subject to change) is used.
state	string	Filter iterations by state.

SELECT examples

list

Find iterations. Generated from the GitLab GraphQL schema field Group.iterations (connection of Iteration nodes).

SELECT
id,
created_at,
description,
due_date,
group_,
iid,
scoped_path,
scoped_url,
sequence,
start_date,
state,
title,
updated_at,
web_path,
web_url
FROM gitlab.groups.group_iterations
WHERE full_path = '{{ full_path }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
AND id = '{{ id }}'
AND iid = '{{ iid }}'
AND include_ancestors = '{{ include_ancestors }}'
AND include_descendants = '{{ include_descendants }}'
AND search = '{{ search }}'
AND sort = '{{ sort }}'
AND state = '{{ state }}'
;