taskBundles

Returns recurrency details for a task template.

Changed on

Returns recurrency details for a task template. The response includes the template's recurrence settings.

<Check title="Required Permissions" icon="key">The user must be an admin or have task-manage-config:read permissions.</Check>

get/tasktemplates/{taskTemplateId}/recurrency

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/tasktemplates/{taskTemplateId}/recurrency
  • Auth: HTTP bearer

Path parameters

taskTemplateIdstring uuid required

The id of the task template.

Response

OK

recurrencyRulestring required

The recurrence rule as cron expression. We support all expressions which cronos supports (https://github.com/HangfireIO/Cronos). The number of occurrences is limited to 24 a day.

recurrencyIntervalinteger nullable

The interval of the executed expression. If the value is 3, only the third time of the expression the recurrence is actually executed.

relativeDueOninteger nullable

The relative due date and time of the task created from this recurrence rule, in seconds, from the moment of creating the task by a recurrence rule.

recurrencyStartOnstring date-time nullable

DateTime when recurring task creation will start, considering the set Recurrency Rule and Recurrency Interval.

recurrencyTimezonestring nullable

The timezone of the Recurrency Rule. If not set, will use the requesting user's timezone.

Changes

  • 1556e0487867Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e46cf415581Revision changes
    • info

      api operation id GetTaskTemplateRecurrencyByTaskTemplateId removed and replaced with taskBundles_GetTaskTemplateRecurrencyByTaskTemplateId