Sign in

v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB
Activity

TaskRecurrences.update

Modifies TaskRecurrence or TaskRecurrences with given id(s)

patch/entities/TaskRecurrences/{id}

Path parameters

idstring uuid required

ID of TaskRecurrence to update

Query parameters

validation-levelinteger

Specify validation level of TaskRecurrence on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.

Request body

apply_recurrenceboolean

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

day1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31

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.

Integer enum value: 1 - Day1, 2 - Day2, 3 - Day3, 4 - Day4, 5 - Day5, 6 - Day6, 7 - Day7, 8 - Day8, 9 - Day9, 10 - Day10, 11 - Day11, 12 - Day12, 13 - Day13, 14 - Day14, 15 - Day15, 16 - Day16, 17 - Day17, 18 - Day18, 19 - Day19, 20 - Day20, 21 - Day21, 22 - Day22, 23 - Day23, 24 - Day24, 25 - Day25, 26 - Day26, 27 - Day27, 28 - Day28, 29 - Day29, 30 - Day30, 31 - Day31

day_of_weekstring

Bit Flag field, with limited combination of integer values.

Options: Sunday = 1 (0b0000001) Monday = 2 (0b0000010) Tuesday = 4 (0b0000100) Wednesday = 8 (0b0001000) Thursday = 16 (0b0010000) Friday = 32 (0b0100000) Saturday = 64 (0b1000000) The days of week in bit mask, number where every bit means one day (e.g. 0010001 = every Monday and Friday), bit 0 is Monday. This setting is applicable only for RecurrenceTypeEnum.Weekly, RecurrenceTypeEnum.MonthlyAbsolute, RecurrenceTypeEnum.YearlyAbsolute.

end_datestring date

Date information. The last date when no more other items should be created.

month1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12

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.

Integer enum value: 1 - Month1, 2 - Month2, 3 - Month3, 4 - Month4, 5 - Month5, 6 - Month6, 7 - Month7, 8 - Month8, 9 - Month9, 10 - Month10, 11 - Month11, 12 - Month12

occur_everyinteger

Generic field wrapping sqlalchemy column, configurable by constructor. Good for one-of fields / generated fields. The number of units of a given recurrence type between occurrences according to RecurrenceTypeEnum.

occurrences_countinteger

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.

start_datestring date

Date information. The effective start date of recurrence, which means each next recurrence must be on or after this date.

task_idstring uuid

Id of the parent task.

type0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10

Recurrence cadence (e.g. Daily, Weekly, MonthlyAbsolute, MonthlyRelative, YearlyAbsolute, YearlyRelative, AfterNDays, AfterNWeeks, AfterNMonths, AfterNYears).

Integer enum value: 0 - NotSet, 1 - Daily, 2 - Weekly, 3 - MonthlyRelative, 4 - MonthlyAbsolute, 5 - YearlyRelative, 6 - YearlyAbsolute, 7 - AfterNDays, 8 - AfterNWeeks, 9 - AfterNMonths, 10 - AfterNYears

week-1 | 1 | 2 | 3 | 4

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.

Integer enum value: -1 - WeekLast, 1 - Week1, 2 - Week2, 3 - Week3, 4 - Week4

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "day": 1,
  "end_date": "2019-01-01",
  "month": 1,
  "occur_every": 1,
  "occurrences_count": 1,
  "start_date": "2019-01-01",
  "task_id": "01234567-abcd-dcba-ffff-000000000000",
  "week": -1,
  "revision": 1
}

Response

Modification confirmation. Returns resulting TaskRecurrence

successboolean

True when response succeeded, false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "day": 1,
    "end_date": "2019-01-01",
    "month": 1,
    "occur_every": 1,
    "occurrences_count": 1,
    "start_date": "2019-01-01",
    "task_id": "01234567-abcd-dcba-ffff-000000000000",
    "week": -1,
    "revision": 1
  }
}