Skip to main content

todo

Gets or lists a todo resource.

Overview​

Nametodo
TypeResource
Idgitlab.users.todo

Fields​

The following fields are returned by SELECT queries:

GraphQL response envelope

NameDatatypeDescription
idstringID of the to-do item.
actionstringAction of the to-do item. (assigned, review_requested, mentioned, build_failed, marked, approval_required, unmergeable, directly_addressed, member_access_requested, review_submitted, ssh_key_expired, ssh_key_expiring_soon, merge_train_removed, okr_checkin_requested, added_approver, duo_pro_access_granted, duo_enterprise_access_granted, duo_core_access_granted, duo_workflow_input_required)
authorobjectUserCore identity (id, username, name)
bodystringBody of the to-do item.
created_atstringTimestamp the to-do item was created.
group_objectGroup identity (id, full_path, name)
member_access_typestringAccess type of access request to-do items.
projectobjectProject identity (id, full_path, name)
snoozed_untilstringTime until when the todo is snoozed.
statestringState of the to-do item. (pending, done)
target_typestringTarget type of the to-do item. (COMMIT, ISSUE, WORKITEM, MERGEREQUEST, DESIGN, ALERT, PROJECT, NAMESPACE, KEY, WIKIPAGEMETA, EPIC, USER, VULNERABILITY, COMPLIANCE_VIOLATION, DUO_WORKFLOW)
target_urlstringURL of the to-do item target.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectid, hostRetrieve a single to-do item Generated from the GitLab GraphQL schema field Query.todo (Todo).

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.

NameDatatypeDescription
hoststringGitLab 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)
idstringID of the to-do item.

SELECT examples​

Retrieve a single to-do item Generated from the GitLab GraphQL schema field Query.todo (Todo).

SELECT
id,
action,
author,
body,
created_at,
group_,
member_access_type,
project,
snoozed_until,
state,
target_type,
target_url
FROM gitlab.users.todo
WHERE id = '{{ id }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
;