Returns the existing recurrency rule for one task template. | awork API

Required Permissions

Any authenticated user.

<Check title="Required Permissions">Any authenticated user.</Check>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

taskTemplateIdstringRequiredformat: "uuid"

Response

recurrencyRulestring>=1 character

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 or null

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

relativeDueOnlong or null

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 or nullformat: "date-time"

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

recurrencyTimezonestring or null

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

1	{
2	"recurrencyRule": "\"0 0 1 * * ?\"",
3	"recurrencyInterval": 1,
4	"relativeDueOn": 3600,
5	"recurrencyStartOn": "2021-03-12T11:00:00Z",
6	"recurrencyTimezone": "Europe/Berlin"
7	}