GraphQL RepositoriesappointmentReminder

`entities.appointmentReminder`

Read appointment reminder records with the appointmentReminder repository, and change them with the appointment reminder mutations. Same records as the REST AppointmentReminders entity.

Example: first three appointment reminder recordsGraphQLcURL

query FirstAppointmentReminders {
  entities {
    appointmentReminder {
      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 FirstAppointmentReminders { entities { appointmentReminder { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id modified } } } } } }"}'

Queries

Fields of entities { appointmentReminder { … } }.

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.	AppointmentReminderEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[AppointmentReminderEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: AppointmentReminderFilterInput, orderBy: [AppointmentReminderOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[AppointmentReminderEntity!]!
QUERY	`getByCriteria`(filter: AppointmentReminderFilterInput, orderBy: [AppointmentReminderOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	AppointmentReminderEntityConnection
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	`createAppointmentReminder`(input: CreateAppointmentReminderInput!, validationLevel: [ValidationLevel!])	Create one record	CreateAppointmentReminderPayload
MUTATION	`updateAppointmentReminder`(input: UpdateAppointmentReminderInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateAppointmentReminderPayload
MUTATION	`bulkUpdateAppointmentReminder`(input: [CreateOrUpdateAppointmentReminderInput!]!, deleteInput: [DeleteAppointmentReminderInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateAppointmentReminderPayload
MUTATION	`deleteAppointmentReminder`(input: DeleteAppointmentReminderInput!)	Soft-delete	DeleteAppointmentReminderPayload

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.

AppointmentReminderEntity object 14 fields: isDeleteProtected, id, isDeleted, …

Reminder a user has set for an appointment, notifying them a given time before it starts.

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.
`appointment`	AppointmentEntity	Appointment this reminder belongs to.
`owner`	ClientEntity	User who set this reminder. Reminders are per-user.
`appointmentId`	ID!	Id of the appointment this reminder belongs to.
`endDateOffset`	Int!	Seconds before the appointment start when the reminder should fire.
`ownerId`	ID!	Id of the user who set the reminder.
`snoozeDate`	DateTime	Timestamp when a snoozed reminder should fire again. Empty when not snoozed.
`status`	ReminderStatusEnum	Current state of the reminder: Scheduled to fire at its set time, Snoozed until snoozeDate, or Dismissed.
`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.

AppointmentReminderEntityConnection object pageInfo: PageInfo!, edges: [AppointmentReminderEntityEdge]!, totalCount: Int

Paginated list of AppointmentReminder records.

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

AppointmentReminderEntityEdge object node: AppointmentReminderEntity, cursor: String!

A Relay edge containing a AppointmentReminderEntity and its cursor.

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

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

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

Input field	Type	Description
`OR`	[AppointmentReminderFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[AppointmentReminderFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	AppointmentReminderFilterInput	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.
`appointmentId`	EntityFilterStringField	Id of the appointment this reminder belongs to.
`endDateOffset`	EntityFilterNumberField	Seconds before the appointment start when the reminder should fire.
`ownerId`	EntityFilterStringField	Id of the user who set the reminder.
`snoozeDate`	EntityFilterDateTimeField	Timestamp when a snoozed reminder should fire again. Empty when not snoozed.
`status`	ReminderStatusEnumFilterInput	Current state of the reminder: Scheduled to fire at its set time, Snoozed until snoozeDate, or Dismissed.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`appointment`	AppointmentFilterInput	Appointment this reminder belongs to. Matches records where a related record meets these conditions.
`owner`	ClientFilterInput	User who set this reminder. Reminders are per-user. Matches records where a related record meets these conditions.

AppointmentReminderOrderByInput input Asc or Desc per field

Sorting of AppointmentReminder 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.
`appointment`	[AppointmentOrderByNestedInput!]	Appointment this reminder belongs to. Sorts by fields of the related record, listed in order of priority.
`owner`	[ClientOrderByNestedInput!]	User who set this reminder. Reminders are per-user. Sorts by fields of the related record, listed in order of priority.
`appointmentId`	OrderByEnum	Id of the appointment this reminder belongs to.
`endDateOffset`	OrderByEnum	Seconds before the appointment start when the reminder should fire.
`ownerId`	OrderByEnum	Id of the user who set the reminder.
`snoozeDate`	OrderByEnum	Timestamp when a snoozed reminder should fire again. Empty when not snoozed.
`status`	OrderByEnum	Current state of the reminder: Scheduled to fire at its set time, Snoozed until snoozeDate, or Dismissed.
`revision`	OrderByEnum	Revision when entity was lastly changed.

CreateAppointmentReminderInput input 9 fields: clientMutationId, modified, created, …

Field values of a new AppointmentReminder 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.
`appointmentId`	ID!	Id of the appointment this reminder belongs to.
`endDateOffset`	Int!	Seconds before the appointment start when the reminder should fire.
`ownerId`	ID!	Id of the user who set the reminder.
`snoozeDate`	DateTime	Timestamp when a snoozed reminder should fire again. Empty when not snoozed.
`status`	ReminderStatusEnum	Current state of the reminder: Scheduled to fire at its set time, Snoozed until snoozeDate, or Dismissed.
`revision`	Int	Revision when entity was lastly changed.

CreateOrUpdateAppointmentReminderInput input 10 fields: clientMutationId, id, modified, …

Field values of an AppointmentReminder 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.
`appointmentId`	ID	Id of the appointment this reminder belongs to.
`endDateOffset`	Int	Seconds before the appointment start when the reminder should fire.
`ownerId`	ID	Id of the user who set the reminder.
`snoozeDate`	DateTime	Timestamp when a snoozed reminder should fire again. Empty when not snoozed.
`status`	ReminderStatusEnum	Current state of the reminder: Scheduled to fire at its set time, Snoozed until snoozeDate, or Dismissed.
`revision`	Int	Revision when entity was lastly changed.

DeleteAppointmentReminderInput input clientMutationId: String, id: ID!

Id of the AppointmentReminder 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.

UpdateAppointmentReminderInput input 10 fields: clientMutationId, id, modified, …

Id of an AppointmentReminder 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.
`appointmentId`	ID	Id of the appointment this reminder belongs to.
`endDateOffset`	Int	Seconds before the appointment start when the reminder should fire.
`ownerId`	ID	Id of the user who set the reminder.
`snoozeDate`	DateTime	Timestamp when a snoozed reminder should fire again. Empty when not snoozed.
`status`	ReminderStatusEnum	Current state of the reminder: Scheduled to fire at its set time, Snoozed until snoozeDate, or Dismissed.
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateAppointmentReminderPayload object result: BulkUpdateResults!

Result of the bulkUpdateAppointmentReminder mutation.

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

CreateAppointmentReminderPayload object appointmentReminder: AppointmentReminderEntity, clientMutationId: String

Result of the createAppointmentReminder mutation.

Field	Type	Description
`appointmentReminder`	AppointmentReminderEntity	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).

DeleteAppointmentReminderPayload object appointmentReminder: AppointmentReminderEntity, clientMutationId: String

Result of the deleteAppointmentReminder mutation.

Field	Type	Description
`appointmentReminder`	AppointmentReminderEntity	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).

UpdateAppointmentReminderPayload object appointmentReminder: AppointmentReminderEntity, clientMutationId: String

Result of the updateAppointmentReminder mutation.

Field	Type	Description
`appointmentReminder`	AppointmentReminderEntity	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).