todo
Gets or lists a todo resource.
Overview​
| Name | todo |
| Type | Resource |
| Id | gitlab.users.todo |
Fields​
The following fields are returned by SELECT queries:
- get
GraphQL response envelope
| Name | Datatype | Description |
|---|---|---|
id | string | ID of the to-do item. |
action | string | Action 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) |
author | object | UserCore identity (id, username, name) |
body | string | Body of the to-do item. |
created_at | string | Timestamp the to-do item was created. |
group_ | object | Group identity (id, full_path, name) |
member_access_type | string | Access type of access request to-do items. |
project | object | Project identity (id, full_path, name) |
snoozed_until | string | Time until when the todo is snoozed. |
state | string | State of the to-do item. (pending, done) |
target_type | string | Target type of the to-do item. (COMMIT, ISSUE, WORKITEM, MERGEREQUEST, DESIGN, ALERT, PROJECT, NAMESPACE, KEY, WIKIPAGEMETA, EPIC, USER, VULNERABILITY, COMPLIANCE_VIOLATION, DUO_WORKFLOW) |
target_url | string | URL of the to-do item target. |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | id, host | Retrieve 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.
| 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 | ID of the to-do item. |
SELECT examples​
- get
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)
;