GraphQL RepositoriestaskReminder

`entities.taskReminder`

Read task reminder records with the taskReminder repository, and change them with the task reminder mutations. Same records as the REST TaskReminders entity.

Example: first three task reminder recordsGraphQLcURL

query FirstTaskReminders {
  entities {
    taskReminder {
      getByCriteria(first: 3, orderBy: [{ modified: Desc }]) {
        totalCount
        edges { node { id modified } }
      }
    }
  }
}

curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query FirstTaskReminders { entities { taskReminder { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id modified } } } } } }"}'

Queries

Fields of entities { taskReminder { … } }.

Kind	Field	Returns
QUERY	`getById`(entityId: ID!) Returns the record with the given id, or null when there is none. Deleted records are returned as well.	TaskReminderEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[TaskReminderEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: TaskReminderFilterInput, orderBy: [TaskReminderOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[TaskReminderEntity!]!
QUERY	`getByCriteria`(filter: TaskReminderFilterInput, orderBy: [TaskReminderOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	TaskReminderEntityConnection
QUERY	`getChangedFieldsSinceRevision`(id: UUID!, revision: Int!) Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.	[UUID!]!

Mutations

Kind	Mutation	Does	Returns
MUTATION	`createTaskReminder`(input: CreateTaskReminderInput!, validationLevel: [ValidationLevel!])	Create one record	CreateTaskReminderPayload
MUTATION	`updateTaskReminder`(input: UpdateTaskReminderInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateTaskReminderPayload
MUTATION	`bulkUpdateTaskReminder`(input: [CreateOrUpdateTaskReminderInput!]!, deleteInput: [DeleteTaskReminderInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateTaskReminderPayload
MUTATION	`deleteTaskReminder`(input: DeleteTaskReminderInput!)	Soft-delete	DeleteTaskReminderPayload

Types

The types this repository uses, each with its fields and their descriptions. Types several repositories share, such as PageInfo and the filter fields, are in the types index.

TaskReminderEntity object 13 fields: isDeleteProtected, id, isDeleted, …

Reminder a user set to be notified about a task at a given time.

Field	Type	Description
`isDeleteProtected`	Boolean!	True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only.
`id`	ID!	Unique identifier of entity.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`owner`	ClientEntity	User who set this reminder. Reminders are per-user.
`task`	TaskEntity	Task this reminder belongs to.
`ownerId`	ID!	Id of the user who set the reminder.
`setDate`	DateTime!	Timestamp when the reminder should fire.
`status`	ReminderStatusEnum	Current state of the reminder: Scheduled to fire at its set time, Snoozed until snoozeDate, or Dismissed.
`taskId`	ID!	Id of the task this reminder belongs to.
`revision`	Int	Revision when entity was lastly changed.
`instancePermissions`	[EntityPermsEnum!]! (1 args)	Permissions the current user has on this record, out of the requested ones.

TaskReminderEntityConnection object pageInfo: PageInfo!, edges: [TaskReminderEntityEdge]!, totalCount: Int

Paginated list of TaskReminder records.

Field	Type	Description
`pageInfo`	PageInfo!	Pagination data for this connection.
`edges`	[TaskReminderEntityEdge]!	Contains the nodes in this connection.
`totalCount`	Int	Total number of items in the connection.

TaskReminderEntityEdge object node: TaskReminderEntity, cursor: String!

A Relay edge containing a TaskReminderEntity and its cursor.

Field	Type	Description
`node`	TaskReminderEntity	The item at the end of the edge
`cursor`	String!	A cursor for use in pagination

TaskReminderFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field

Filter conditions for TaskReminder records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.

Input field	Type	Description
`OR`	[TaskReminderFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[TaskReminderFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	TaskReminderFilterInput	Matches records that do not meet this filter.
`globalSearchQuery`	String	Search term matched against the fields that the global search covers for this entity.
`id`	EntityFilterStringField	Unique identifier of entity.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	EntityFilterDateTimeField	Last modification time.
`created`	EntityFilterDateTimeField	Creation time.
`ownerId`	EntityFilterStringField	Id of the user who set the reminder.
`setDate`	EntityFilterDateTimeField	Timestamp when the reminder should fire.
`status`	ReminderStatusEnumFilterInput	Current state of the reminder: Scheduled to fire at its set time, Snoozed until snoozeDate, or Dismissed.
`taskId`	EntityFilterStringField	Id of the task this reminder belongs to.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`owner`	ClientFilterInput	User who set this reminder. Reminders are per-user. Matches records where a related record meets these conditions.
`task`	TaskFilterInput	Task this reminder belongs to. Matches records where a related record meets these conditions.

TaskReminderOrderByInput input Asc or Desc per field

Sorting of TaskReminder records. Set exactly one field in each item; list several items to sort by more fields, in order of priority.

Input field	Type	Description
`id`	OrderByEnum	Unique identifier of entity.
`isDeleted`	OrderByEnum	Specifies if the entity is considered deleted.
`modified`	OrderByEnum	Last modification time.
`created`	OrderByEnum	Creation time.
`owner`	[ClientOrderByNestedInput!]	User who set this reminder. Reminders are per-user. Sorts by fields of the related record, listed in order of priority.
`task`	[TaskOrderByNestedInput!]	Task this reminder belongs to. Sorts by fields of the related record, listed in order of priority.
`ownerId`	OrderByEnum	Id of the user who set the reminder.
`setDate`	OrderByEnum	Timestamp when the reminder should fire.
`status`	OrderByEnum	Current state of the reminder: Scheduled to fire at its set time, Snoozed until snoozeDate, or Dismissed.
`taskId`	OrderByEnum	Id of the task this reminder belongs to.
`revision`	OrderByEnum	Revision when entity was lastly changed.

CreateOrUpdateTaskReminderInput input 9 fields: clientMutationId, id, modified, …

Field values of a TaskReminder record to create, or to update when its id is set.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID	Unique identifier of entity.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`ownerId`	ID	Id of the user who set the reminder.
`setDate`	DateTime	Timestamp when the reminder should fire.
`status`	ReminderStatusEnum	Current state of the reminder: Scheduled to fire at its set time, Snoozed until snoozeDate, or Dismissed.
`taskId`	ID	Id of the task this reminder belongs to.
`revision`	Int	Revision when entity was lastly changed.

CreateTaskReminderInput input 8 fields: clientMutationId, modified, created, …

Field values of a new TaskReminder record.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`ownerId`	ID!	Id of the user who set the reminder.
`setDate`	DateTime!	Timestamp when the reminder should fire.
`status`	ReminderStatusEnum	Current state of the reminder: Scheduled to fire at its set time, Snoozed until snoozeDate, or Dismissed.
`taskId`	ID!	Id of the task this reminder belongs to.
`revision`	Int	Revision when entity was lastly changed.

DeleteTaskReminderInput input clientMutationId: String, id: ID!

Id of the TaskReminder record to delete.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID!	Unique identifier of entity.

UpdateTaskReminderInput input 9 fields: clientMutationId, id, modified, …

Id of a TaskReminder record and the field values to change.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID!	Unique identifier of entity.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`ownerId`	ID	Id of the user who set the reminder.
`setDate`	DateTime	Timestamp when the reminder should fire.
`status`	ReminderStatusEnum	Current state of the reminder: Scheduled to fire at its set time, Snoozed until snoozeDate, or Dismissed.
`taskId`	ID	Id of the task this reminder belongs to.
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateTaskReminderPayload object result: BulkUpdateResults!

Result of the bulkUpdateTaskReminder mutation.

Field	Type	Description
`result`	BulkUpdateResults!	Ids of the created, updated and deleted records, and the items that failed.

CreateTaskReminderPayload object taskReminder: TaskReminderEntity, clientMutationId: String

Result of the createTaskReminder mutation.

Field	Type	Description
`taskReminder`	TaskReminderEntity	The created record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

DeleteTaskReminderPayload object taskReminder: TaskReminderEntity, clientMutationId: String

Result of the deleteTaskReminder mutation.

Field	Type	Description
`taskReminder`	TaskReminderEntity	The deleted record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

UpdateTaskReminderPayload object taskReminder: TaskReminderEntity, clientMutationId: String

Result of the updateTaskReminder mutation.

Field	Type	Description
`taskReminder`	TaskReminderEntity	The updated record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).