GraphQL RepositoriestaskRecurrence

`entities.taskRecurrence`

Read task recurrence records with the taskRecurrence repository, and change them with the task recurrence mutations. Same records as the REST TaskRecurrences entity.

Example: first three task recurrence recordsGraphQLcURL

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

Queries

Fields of entities { taskRecurrence { … } }.

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.	TaskRecurrenceEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[TaskRecurrenceEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: TaskRecurrenceFilterInput, orderBy: [TaskRecurrenceOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[TaskRecurrenceEntity!]!
QUERY	`getByCriteria`(filter: TaskRecurrenceFilterInput, orderBy: [TaskRecurrenceOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	TaskRecurrenceEntityConnection
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	`createTaskRecurrence`(input: CreateTaskRecurrenceInput!, validationLevel: [ValidationLevel!])	Create one record	CreateTaskRecurrencePayload
MUTATION	`updateTaskRecurrence`(input: UpdateTaskRecurrenceInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateTaskRecurrencePayload
MUTATION	`bulkUpdateTaskRecurrence`(input: [CreateOrUpdateTaskRecurrenceInput!]!, deleteInput: [DeleteTaskRecurrenceInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateTaskRecurrencePayload
MUTATION	`deleteTaskRecurrence`(input: DeleteTaskRecurrenceInput!)	Soft-delete	DeleteTaskRecurrencePayload

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.

TaskRecurrenceEntity object 18 fields: isDeleteProtected, id, isDeleted, …

Recurrence rule that defines when the next occurrences of a recurring task are created.

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.
`task`	TaskEntity	Task this recurrence belongs to. Each recurrence is bound to exactly one task.
`day`	DateDayEnum	Field whose values are strictly defined with an enumeration of values. The day of the month. This setting is applicable only for RecurrenceTypeEnum.MonthlyRelative and RecurrenceTypeEnum.YearlyRelative.
`dayOfWeek`	Int	Bit Flag field, with limited combination of integer values.
`endDate`	Date	Date information. The last date when no more other items should be created.
`month`	DateMonthEnum	Field whose values are strictly defined with an enumeration of values. The number of month this setting is applicable only for RecurrenceTypeEnum.YearlyAbsolute and RecurrenceTypeEnum.YearlyRelative.
`occurEvery`	Int	The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum.
`occurrencesCount`	Int	Whole natural number. The number of remaining occurrences. Each time a new one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0, recurrence is stopped. If -1, no limits are applied.
`startDate`	Date!	Date information. The effective start date of recurrence, which means each next recurrence must be on or after this date.
`taskId`	ID!	Id of the parent task.
`type`	RecurrenceTypeEnum	Recurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative, AfterNDays, AfterNWeeks, AfterNMonths, AfterNYears).
`week`	DateWeekEnum	Field whose values are strictly defined with an enumeration of values. The week of month. This setting is applicable only for RecurrenceTypeEnum.MonthlyAbsolute and RecurrenceTypeEnum.YearlyAbsolute.
`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.

TaskRecurrenceEntityConnection object pageInfo: PageInfo!, edges: [TaskRecurrenceEntityEdge]!, totalCount: Int

Paginated list of TaskRecurrence records.

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

TaskRecurrenceEntityEdge object node: TaskRecurrenceEntity, cursor: String!

A Relay edge containing a TaskRecurrenceEntity and its cursor.

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

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

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

Input field	Type	Description
`OR`	[TaskRecurrenceFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[TaskRecurrenceFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	TaskRecurrenceFilterInput	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.
`day`	DateDayEnumFilterInput	Field whose values are strictly defined with an enumeration of values. The day of the month. This setting is applicable only for RecurrenceTypeEnum.MonthlyRelative and RecurrenceTypeEnum.YearlyRelative.
`dayOfWeek`	DateDayOfWeekEnumFilterInput	Bit Flag field, with limited combination of integer values.
`month`	DateMonthEnumFilterInput	Field whose values are strictly defined with an enumeration of values. The number of month this setting is applicable only for RecurrenceTypeEnum.YearlyAbsolute and RecurrenceTypeEnum.YearlyRelative.
`occurEvery`	EntityFilterNumberField	The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum.
`occurrencesCount`	EntityFilterNumberField	Whole natural number. The number of remaining occurrences. Each time a new one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0, recurrence is stopped. If -1, no limits are applied.
`taskId`	EntityFilterStringField	Id of the parent task.
`type`	RecurrenceTypeEnumFilterInput	Recurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative, AfterNDays, AfterNWeeks, AfterNMonths, AfterNYears).
`week`	DateWeekEnumFilterInput	Field whose values are strictly defined with an enumeration of values. The week of month. This setting is applicable only for RecurrenceTypeEnum.MonthlyAbsolute and RecurrenceTypeEnum.YearlyAbsolute.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`task`	TaskFilterInput	Task this recurrence belongs to. Each recurrence is bound to exactly one task. Matches records where a related record meets these conditions.

TaskRecurrenceOrderByInput input Asc or Desc per field

Sorting of TaskRecurrence 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.
`task`	[TaskOrderByNestedInput!]	Task this recurrence belongs to. Each recurrence is bound to exactly one task. Sorts by fields of the related record, listed in order of priority.
`day`	OrderByEnum	Field whose values are strictly defined with an enumeration of values. The day of the month. This setting is applicable only for RecurrenceTypeEnum.MonthlyRelative and RecurrenceTypeEnum.YearlyRelative.
`dayOfWeek`	OrderByEnum	Bit Flag field, with limited combination of integer values.
`endDate`	OrderByEnum	Date information. The last date when no more other items should be created.
`month`	OrderByEnum	Field whose values are strictly defined with an enumeration of values. The number of month this setting is applicable only for RecurrenceTypeEnum.YearlyAbsolute and RecurrenceTypeEnum.YearlyRelative.
`occurEvery`	OrderByEnum	The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum.
`occurrencesCount`	OrderByEnum	Whole natural number. The number of remaining occurrences. Each time a new one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0, recurrence is stopped. If -1, no limits are applied.
`startDate`	OrderByEnum	Date information. The effective start date of recurrence, which means each next recurrence must be on or after this date.
`taskId`	OrderByEnum	Id of the parent task.
`type`	OrderByEnum	Recurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative, AfterNDays, AfterNWeeks, AfterNMonths, AfterNYears).
`week`	OrderByEnum	Field whose values are strictly defined with an enumeration of values. The week of month. This setting is applicable only for RecurrenceTypeEnum.MonthlyAbsolute and RecurrenceTypeEnum.YearlyAbsolute.
`revision`	OrderByEnum	Revision when entity was lastly changed.

CreateOrUpdateTaskRecurrenceInput input 16 fields: clientMutationId, applyRecurrence, id, …

Field values of a TaskRecurrence 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).
`applyRecurrence`	Boolean	Default true. When set, then reccurence will apply when other conditions passed. With the value false (e.g. when skip button is used) then recurrence will not apply
`id`	ID	Unique identifier of entity.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`day`	DateDayEnum	Field whose values are strictly defined with an enumeration of values. The day of the month. This setting is applicable only for RecurrenceTypeEnum.MonthlyRelative and RecurrenceTypeEnum.YearlyRelative.
`dayOfWeek`	Int	Bit Flag field, with limited combination of integer values.
`endDate`	Date	Date information. The last date when no more other items should be created.
`month`	DateMonthEnum	Field whose values are strictly defined with an enumeration of values. The number of month this setting is applicable only for RecurrenceTypeEnum.YearlyAbsolute and RecurrenceTypeEnum.YearlyRelative.
`occurEvery`	Int	The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum.
`occurrencesCount`	Int	Whole natural number. The number of remaining occurrences. Each time a new one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0, recurrence is stopped. If -1, no limits are applied.
`startDate`	Date	Date information. The effective start date of recurrence, which means each next recurrence must be on or after this date.
`taskId`	ID	Id of the parent task.
`type`	RecurrenceTypeEnum	Recurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative, AfterNDays, AfterNWeeks, AfterNMonths, AfterNYears).
`week`	DateWeekEnum	Field whose values are strictly defined with an enumeration of values. The week of month. This setting is applicable only for RecurrenceTypeEnum.MonthlyAbsolute and RecurrenceTypeEnum.YearlyAbsolute.
`revision`	Int	Revision when entity was lastly changed.

CreateTaskRecurrenceInput input 15 fields: clientMutationId, applyRecurrence, modified, …

Field values of a new TaskRecurrence 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).
`applyRecurrence`	Boolean	Default true. When set, then reccurence will apply when other conditions passed. With the value false (e.g. when skip button is used) then recurrence will not apply
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`day`	DateDayEnum	Field whose values are strictly defined with an enumeration of values. The day of the month. This setting is applicable only for RecurrenceTypeEnum.MonthlyRelative and RecurrenceTypeEnum.YearlyRelative.
`dayOfWeek`	Int	Bit Flag field, with limited combination of integer values.
`endDate`	Date	Date information. The last date when no more other items should be created.
`month`	DateMonthEnum	Field whose values are strictly defined with an enumeration of values. The number of month this setting is applicable only for RecurrenceTypeEnum.YearlyAbsolute and RecurrenceTypeEnum.YearlyRelative.
`occurEvery`	Int	The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum.
`occurrencesCount`	Int	Whole natural number. The number of remaining occurrences. Each time a new one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0, recurrence is stopped. If -1, no limits are applied.
`startDate`	Date!	Date information. The effective start date of recurrence, which means each next recurrence must be on or after this date.
`taskId`	ID!	Id of the parent task.
`type`	RecurrenceTypeEnum	Recurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative, AfterNDays, AfterNWeeks, AfterNMonths, AfterNYears).
`week`	DateWeekEnum	Field whose values are strictly defined with an enumeration of values. The week of month. This setting is applicable only for RecurrenceTypeEnum.MonthlyAbsolute and RecurrenceTypeEnum.YearlyAbsolute.
`revision`	Int	Revision when entity was lastly changed.

DeleteTaskRecurrenceInput input clientMutationId: String, id: ID!

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

UpdateTaskRecurrenceInput input 16 fields: clientMutationId, applyRecurrence, id, …

Id of a TaskRecurrence 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).
`applyRecurrence`	Boolean	Default true. When set, then reccurence will apply when other conditions passed. With the value false (e.g. when skip button is used) then recurrence will not apply
`id`	ID!	Unique identifier of entity.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`day`	DateDayEnum	Field whose values are strictly defined with an enumeration of values. The day of the month. This setting is applicable only for RecurrenceTypeEnum.MonthlyRelative and RecurrenceTypeEnum.YearlyRelative.
`dayOfWeek`	Int	Bit Flag field, with limited combination of integer values.
`endDate`	Date	Date information. The last date when no more other items should be created.
`month`	DateMonthEnum	Field whose values are strictly defined with an enumeration of values. The number of month this setting is applicable only for RecurrenceTypeEnum.YearlyAbsolute and RecurrenceTypeEnum.YearlyRelative.
`occurEvery`	Int	The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum.
`occurrencesCount`	Int	Whole natural number. The number of remaining occurrences. Each time a new one is created, it decreases. When item is set to 1, only last one can be created. If it is set to 0, recurrence is stopped. If -1, no limits are applied.
`startDate`	Date	Date information. The effective start date of recurrence, which means each next recurrence must be on or after this date.
`taskId`	ID	Id of the parent task.
`type`	RecurrenceTypeEnum	Recurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative, AfterNDays, AfterNWeeks, AfterNMonths, AfterNYears).
`week`	DateWeekEnum	Field whose values are strictly defined with an enumeration of values. The week of month. This setting is applicable only for RecurrenceTypeEnum.MonthlyAbsolute and RecurrenceTypeEnum.YearlyAbsolute.
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateTaskRecurrencePayload object result: BulkUpdateResults!

Result of the bulkUpdateTaskRecurrence mutation.

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

CreateTaskRecurrencePayload object taskRecurrence: TaskRecurrenceEntity, clientMutationId: String

Result of the createTaskRecurrence mutation.

Field	Type	Description
`taskRecurrence`	TaskRecurrenceEntity	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).

DeleteTaskRecurrencePayload object taskRecurrence: TaskRecurrenceEntity, clientMutationId: String

Result of the deleteTaskRecurrence mutation.

Field	Type	Description
`taskRecurrence`	TaskRecurrenceEntity	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).

UpdateTaskRecurrencePayload object taskRecurrence: TaskRecurrenceEntity, clientMutationId: String

Result of the updateTaskRecurrence mutation.

Field	Type	Description
`taskRecurrence`	TaskRecurrenceEntity	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).