project_board

Gets or lists a project_board resource.

Overview

Name	project_board
Type	Resource
Id	gitlab.boards.project_board

Fields

The following fields are returned by SELECT queries:

get

GraphQL response envelope

Name	Datatype	Description
id	string	ID (global ID) of the board.
name	string	Name of the board.
created_at	string	Timestamp of when the board was created.
hide_backlog_list	boolean	Whether or not backlog list is hidden.
hide_closed_list	boolean	Whether or not closed list is hidden.
milestone	object	Milestone identity (id, title)
updated_at	string	Timestamp of when the board was last updated.
web_path	string	Web path of the board.
web_url	string	Web URL of the board.
weight	integer	Weight of the board.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	full_path, id, host		A single board of the project. Generated from the GitLab GraphQL schema field Project.board (Board).

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)
id	string	ID of the board.

SELECT examples

get

A single board of the project. Generated from the GitLab GraphQL schema field Project.board (Board).

SELECT
id,
name,
created_at,
hide_backlog_list,
hide_closed_list,
milestone,
updated_at,
web_path,
web_url,
weight
FROM gitlab.boards.project_board
WHERE full_path = '{{ full_path }}' -- required
AND id = '{{ id }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
;