project_issue

Gets or lists a project_issue resource.

Overview

Name	project_issue
Type	Resource
Id	gitlab.issues.project_issue

Fields

The following fields are returned by SELECT queries:

get

GraphQL response envelope

Name	Datatype	Description
id	string	ID of the issue.
name	string	Name or title of the object.
project_id	integer	ID of the issue project.
author	object	UserCore identity (id, username, name)
blocked	boolean	Indicates the issue is blocked.
blocked_by_count	integer	Count of issues blocking the issue.
blocking_count	integer	Count of issues the issue is blocking.
closed_at	string	Timestamp of when the issue was closed.
confidential	boolean	Indicates the issue is confidential.
create_note_email	string	User specific email address for the issue.
created_at	string	Timestamp of when the issue was created.
description	string	Description of the issue.
discussion_locked	boolean	Indicates discussion is locked on the issue.
downvotes	integer	Number of downvotes the issue has received.
due_date	string	Due date of the issue.
emails_enabled	boolean	Indicates if the parent project or group has email notifications disabled: false if email notifications are disabled.
escalation_status	string	Escalation status of the issue. (TRIGGERED, ACKNOWLEDGED, RESOLVED, IGNORED)
external_author	string	Email address of non-GitLab user reporting the issue. For guests, the email address is obfuscated.
has_epic	boolean	Indicates if the issue belongs to an epic. Can return true and not show an associated epic when the user has no access to the epic.
health_status	string	Current health status. (onTrack, needsAttention, atRisk)
hidden	boolean	Indicates the issue is hidden because the author has been banned.
human_time_estimate	string	Human-readable time estimate of the issue.
human_total_time_spent	string	Human-readable total time reported as spent on the issue.
iid	string	Internal ID of the issue.
merge_requests_count	integer	Number of merge requests that close the issue on merge.
milestone	object	Milestone identity (id, title)
moved	boolean	Indicates if issue got moved from other project.
reference	string	Internal reference of the issue. Returned in shortened format by default.
relative_position	integer	Relative position of the issue (used for positioning in epic tree and issue boards).
severity	string	Severity level of the incident. (UNKNOWN, LOW, MEDIUM, HIGH, CRITICAL)
sla_due_at	string	Timestamp of when the issue SLA expires.
state	string	State of the issue. (opened, closed, locked, all)
status_page_published_incident	boolean	Indicates whether an issue is published to the status page.
subscribed	boolean	Indicates the currently logged in user is subscribed to the issue.
time_estimate	integer	Time estimate of the issue.
title	string	Title of the issue.
total_time_spent	integer	Total time (in seconds) reported as spent on the issue.
type	string	Type of the issue. (ISSUE, INCIDENT, TEST_CASE, REQUIREMENT, TASK, TICKET)
updated_at	string	Timestamp of when the issue was last updated.
upvotes	integer	Number of upvotes the issue has received.
user_discussions_count	integer	Number of user discussions in the issue.
user_notes_count	integer	Number of user notes of the issue.
web_path	string	Web path of the issue.
web_url	string	Web URL of the issue.
weight	integer	Weight of the issue.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	full_path, host	assignee_id, assignee_wildcard_id, author_username, closed_after, closed_before, confidential, created_after, created_before, crm_contact_id, crm_organization_id, due_after, due_before, epic_id, epic_wildcard_id, health_status_filter, iid, include_subepics, iteration_title, iteration_wildcard_id, milestone_wildcard_id, my_reaction_emoji, release_tag_wildcard_id, search, sort, state, subscribed, updated_after, updated_before, weight, weight_wildcard_id	A single issue of the project. Generated from the GitLab GraphQL schema field Project.issue (Issue).

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)
assignee_id	string	ID of a user assigned to the issues. Wildcard values "NONE" and "ANY" are supported.
assignee_wildcard_id	string	Filter by assignee wildcard. Incompatible with assigneeUsername and assigneeUsernames.
author_username	string	Username of the author of the issue.
closed_after	string	Issues closed after the date.
closed_before	string	Issues closed before the date.
confidential	boolean	Filter for confidential issues. If "false", excludes confidential issues. If "true", returns only confidential issues.
created_after	string	Issues created after the date.
created_before	string	Issues created before the date.
crm_contact_id	string	ID of a contact assigned to the issues.
crm_organization_id	string	ID of an organization assigned to the issues.
due_after	string	Return issues due on or after the given time.
due_before	string	Return issues due on or before the given time.
epic_id	string	ID of an epic associated with the issues, "none" and "any" values are supported.
epic_wildcard_id	string	Filter by epic ID wildcard. Incompatible with epicId.
health_status_filter	string	Health status of the issue, "none" and "any" values are supported.
iid	string	IID of the issue. For example, "1".
include_subepics	boolean	Whether to include subepics when filtering issues by epicId.
iteration_title	string	Filter by iteration title.
iteration_wildcard_id	string	Filter by iteration ID wildcard.
milestone_wildcard_id	string	Filter issues by milestone ID wildcard.
my_reaction_emoji	string	Filter by reaction emoji applied by the current user. Wildcard values "NONE" and "ANY" are supported.
release_tag_wildcard_id	string	Filter issues by release tag ID wildcard.
search	string	Search query for title or description.
sort	string	Sort issues by the criteria.
state	string	Current state of the issue.
subscribed	string	Issues the current user is subscribed to.
updated_after	string	Issues updated after the date.
updated_before	string	Issues updated before the date.
weight	string	Weight applied to the issue, "none" and "any" values are supported.
weight_wildcard_id	string	Filter by weight ID wildcard. Incompatible with weight.

SELECT examples

get

A single issue of the project. Generated from the GitLab GraphQL schema field Project.issue (Issue).

SELECT
id,
name,
project_id,
author,
blocked,
blocked_by_count,
blocking_count,
closed_at,
confidential,
create_note_email,
created_at,
description,
discussion_locked,
downvotes,
due_date,
emails_enabled,
escalation_status,
external_author,
has_epic,
health_status,
hidden,
human_time_estimate,
human_total_time_spent,
iid,
merge_requests_count,
milestone,
moved,
reference,
relative_position,
severity,
sla_due_at,
state,
status_page_published_incident,
subscribed,
time_estimate,
title,
total_time_spent,
type,
updated_at,
upvotes,
user_discussions_count,
user_notes_count,
web_path,
web_url,
weight
FROM gitlab.issues.project_issue
WHERE full_path = '{{ full_path }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
AND assignee_id = '{{ assignee_id }}'
AND assignee_wildcard_id = '{{ assignee_wildcard_id }}'
AND author_username = '{{ author_username }}'
AND closed_after = '{{ closed_after }}'
AND closed_before = '{{ closed_before }}'
AND confidential = '{{ confidential }}'
AND created_after = '{{ created_after }}'
AND created_before = '{{ created_before }}'
AND crm_contact_id = '{{ crm_contact_id }}'
AND crm_organization_id = '{{ crm_organization_id }}'
AND due_after = '{{ due_after }}'
AND due_before = '{{ due_before }}'
AND epic_id = '{{ epic_id }}'
AND epic_wildcard_id = '{{ epic_wildcard_id }}'
AND health_status_filter = '{{ health_status_filter }}'
AND iid = '{{ iid }}'
AND include_subepics = '{{ include_subepics }}'
AND iteration_title = '{{ iteration_title }}'
AND iteration_wildcard_id = '{{ iteration_wildcard_id }}'
AND milestone_wildcard_id = '{{ milestone_wildcard_id }}'
AND my_reaction_emoji = '{{ my_reaction_emoji }}'
AND release_tag_wildcard_id = '{{ release_tag_wildcard_id }}'
AND search = '{{ search }}'
AND sort = '{{ sort }}'
AND state = '{{ state }}'
AND subscribed = '{{ subscribed }}'
AND updated_after = '{{ updated_after }}'
AND updated_before = '{{ updated_before }}'
AND weight = '{{ weight }}'
AND weight_wildcard_id = '{{ weight_wildcard_id }}'
;