board_list

Gets or lists a board_list resource.

Overview

Name	board_list
Type	Resource
Id	gitlab.boards.board_list

Fields

The following fields are returned by SELECT queries:

get

GraphQL response envelope

Name	Datatype	Description
id	string	ID (global ID) of the list.
collapsed	boolean	Indicates if the list is collapsed for the user.
issues_count	integer	Count of issues in the list.
limit_metric	string	Current limit metric for the list. (all_metrics, issue_count, issue_weights)
list_type	string	Type of the list.
max_issue_count	integer	Maximum number of issues in the list.
max_issue_weight	integer	Maximum weight of issues in the list.
milestone	object	Milestone identity (id, title)
position	integer	Position of list within the board.
title	string	Title of the list.
total_issue_weight	string	Total weight of all issues in the list, encoded as a string.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id, host		Find an issue board list. Generated from the GitLab GraphQL schema field Query.boardList (BoardList).

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
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 list.

SELECT examples

get

Find an issue board list. Generated from the GitLab GraphQL schema field Query.boardList (BoardList).

SELECT
id,
collapsed,
issues_count,
limit_metric,
list_type,
max_issue_count,
max_issue_weight,
milestone,
position,
title,
total_issue_weight
FROM gitlab.boards.board_list
WHERE id = '{{ id }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
;