Gets recurrency details for a task template. | awork API

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

Required Permissions

The user must be an admin or have task-manage-config:read permissions.

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

Authentication

AuthorizationBearer

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

Path parameters

taskTemplateIdstringRequiredformat: "uuid"

The id of the task template.

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.

Errors

404

Not Found Error

Required Permissions

The user must be an admin or have task-manage-config:read permissions.

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

The id of the task template.

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.

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

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.

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

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	}

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

$	curl https://api.awork.com/api/v1/tasktemplates/taskTemplateId/recurrency \
>	-H "Authorization: Bearer <token>"