API v1 ReferenceTasks

Gets the recurrency rule for the specified task.

<Check> <b>Required Permissions</b>: read permissions on the task.</Check>

Returns 404 NotFound if no recurrence rule exists.

Path parameters

taskIdUUIDRequired

Headers

AuthorizationstringRequired

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

Response

OK

recurrencyRulestring or nullOptional

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 nullOptional

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 nullOptional

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.

recurrencyStartOndatetime or nullOptional

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

recurrencyTimezonestring or nullOptional

The timezone of the Recurrency Rule.