group_work_item

Gets or lists a group_work_item resource.

Overview

Name	group_work_item
Type	Resource
Id	gitlab.work_items.group_work_item

Fields

The following fields are returned by SELECT queries:

get

GraphQL response envelope

Name	Datatype	Description
id	string	Global ID of the work item.
name	string	Name or title of the object.
closed_at	string	Timestamp of when the work item was closed.
confidential	boolean	Indicates the work item is confidential.
create_note_email	string	User specific email address for the work item.
created_at	string	Timestamp of when the work item was created.
description	string	Description of the work item.
duplicated_to_work_item_url	string	URL of the work item that the work item is marked as a duplicate of.
hidden	boolean	Indicates the work item is hidden because the author has been banned.
iid	string	Internal ID of the work item.
imported	boolean	Indicates whether the work item was imported.
lock_version	integer	Lock version of the work item. Incremented each time the work item is updated.
moved_to_work_item_url	string	URL of the work item that the work item was moved to.
promoted_to_epic_url	string	URL of the epic that the work item has been promoted to.
reference	string	Internal reference of the work item. Returned in shortened format by default.
state	string	State of the work item. (OPEN, CLOSED)
title	string	Title of the work item.
updated_at	string	Timestamp of when the work item was last updated.
user_discussions_count	integer	Number of user discussions in the work item.
web_path	string	Web path of the object.
web_url	string	URL of the object.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	full_path, iid, host		Find a work item by IID directly associated with the group. Generated from the GitLab GraphQL schema field Group.workItem (WorkItem).

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)
iid	string	IID of the work item.

SELECT examples

get

Find a work item by IID directly associated with the group. Generated from the GitLab GraphQL schema field Group.workItem (WorkItem).

SELECT
id,
name,
closed_at,
confidential,
create_note_email,
created_at,
description,
duplicated_to_work_item_url,
hidden,
iid,
imported,
lock_version,
moved_to_work_item_url,
promoted_to_epic_url,
reference,
state,
title,
updated_at,
user_discussions_count,
web_path,
web_url
FROM gitlab.work_items.group_work_item
WHERE full_path = '{{ full_path }}' -- required
AND iid = '{{ iid }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
;