epic_board_list
Creates, updates, deletes, gets or lists an epic_board_list resource.
Overview​
| Name | epic_board_list |
| Type | Resource |
| Id | gitlab.boards.epic_board_list |
Fields​
The following fields are returned by SELECT queries:
- get
GraphQL response envelope
| Name | Datatype | Description |
|---|---|---|
id | string | Global ID of the board list. |
collapsed | boolean | Indicates if the list is collapsed for the user. |
list_type | string | Type of the list. |
position | integer | Position of the list within the board. |
title | string | Title of the list. |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | id, host | get epic_board_list Generated from the GitLab GraphQL schema field Query.epicBoardList (EpicList). |
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
get epic_board_list Generated from the GitLab GraphQL schema field Query.epicBoardList (EpicList).
SELECT
id,
collapsed,
list_type,
position,
title
FROM gitlab.boards.epic_board_list
WHERE id = '{{ id }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
;