HomepageBlog

Task_schedules

Lists all task schedules.

get

API Key Scope: task_schedules / index

Authorizations
Query parameters
with_nextbooleanOptional

Display the next scheduled date, and information about missing executions.

Default: true
limitintegerOptional

The number of items to display for pagination.

offsetintegerOptional

The number of items to skip for pagination.

sort_bystring[]Optional

Sort results by attribute.

Can sort on multiple attributes, separated by |. Order direction can be suffixing the attribute by either :asc (default) or :desc.

idstringOptional

Filter on id

rrulestringOptional

Filter on RRule of schedule

donestringOptional

Filter on done schedule

task_idstringOptional

Filter on task id

Responses
200

List of task schedules.

application/json
get
/task_schedules
GET /api/v2/task_schedules HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
200

List of task schedules.

{
  "count": 1,
  "task_schedules": [
    {
      "id": 1,
      "task_id": 16,
      "rrule": "DTSTART;TZID=Europe/Paris:20190705T085000\nRRULE:FREQ=WEEKLY",
      "done": false,
      "next": "2019-10-11T15:00:00Z",
      "missed_count": 2,
      "skipped_count": 0,
      "missed_last": "2019-10-11T13:00:00Z",
      "missed_first": "2019-10-11T11:00:00Z"
    }
  ]
}

Displays the task schedule.

get

API Key Scope: task_schedules / show

Authorizations
Path parameters
task_idstringRequired

Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.

Responses
200

A specific task schedule.

application/json
get
/tasks/{task_id}/task_schedule
GET /api/v2/tasks/{task_id}/task_schedule HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
200

A specific task schedule.

{
  "id": 1,
  "task_id": 16,
  "rrule": "DTSTART;TZID=Europe/Paris:20190705T085000\nRRULE:FREQ=WEEKLY",
  "done": false,
  "next": "2019-10-11T15:00:00Z",
  "missed_count": 2,
  "skipped_count": 0,
  "missed_last": "2019-10-11T13:00:00Z",
  "missed_first": "2019-10-11T11:00:00Z"
}

Creates a new task schedule. Only one should be created.

post

API Key Scope: task_schedules / create

Authorizations
Path parameters
task_idstringRequired

Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.

Body
idinteger · int64Read-onlyOptional
task_idinteger · int64OptionalExample: 16
rrulestringOptionalExample: DTSTART;TZID=Europe/Paris:20190705T085000 RRULE:FREQ=WEEKLY
donebooleanOptionalExample: false
nextstringRead-onlyOptionalExample: 2019-10-11T15:00:00Z
missed_countintegerRead-onlyOptionalExample: 2
skipped_countintegerRead-onlyOptionalExample: 0
missed_laststringRead-onlyOptionalExample: 2019-10-11T13:00:00Z
missed_firststringRead-onlyOptionalExample: 2019-10-11T11:00:00Z
Responses
201

A specific task schedule.

application/json
post
/tasks/{task_id}/task_schedule
POST /api/v2/tasks/{task_id}/task_schedule HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 98

{
  "task_id": 16,
  "rrule": "DTSTART;TZID=Europe/Paris:20190705T085000\nRRULE:FREQ=WEEKLY",
  "done": false
}
{
  "id": 1,
  "task_id": 16,
  "rrule": "DTSTART;TZID=Europe/Paris:20190705T085000\nRRULE:FREQ=WEEKLY",
  "done": false,
  "next": "2019-10-11T15:00:00Z",
  "missed_count": 2,
  "skipped_count": 0,
  "missed_last": "2019-10-11T13:00:00Z",
  "missed_first": "2019-10-11T11:00:00Z"
}

Updates the existing task schedule.

put

API Key Scope: task_schedules / update

Authorizations
Path parameters
task_idstringRequired

Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.

Body
idinteger · int64Read-onlyOptional
task_idinteger · int64OptionalExample: 16
rrulestringOptionalExample: DTSTART;TZID=Europe/Paris:20190705T085000 RRULE:FREQ=WEEKLY
donebooleanOptionalExample: false
nextstringRead-onlyOptionalExample: 2019-10-11T15:00:00Z
missed_countintegerRead-onlyOptionalExample: 2
skipped_countintegerRead-onlyOptionalExample: 0
missed_laststringRead-onlyOptionalExample: 2019-10-11T13:00:00Z
missed_firststringRead-onlyOptionalExample: 2019-10-11T11:00:00Z
Responses
200

A specific task schedule.

application/json
put
/tasks/{task_id}/task_schedule
PUT /api/v2/tasks/{task_id}/task_schedule HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 98

{
  "task_id": 16,
  "rrule": "DTSTART;TZID=Europe/Paris:20190705T085000\nRRULE:FREQ=WEEKLY",
  "done": false
}
{
  "id": 1,
  "task_id": 16,
  "rrule": "DTSTART;TZID=Europe/Paris:20190705T085000\nRRULE:FREQ=WEEKLY",
  "done": false,
  "next": "2019-10-11T15:00:00Z",
  "missed_count": 2,
  "skipped_count": 0,
  "missed_last": "2019-10-11T13:00:00Z",
  "missed_first": "2019-10-11T11:00:00Z"
}

Destroys the task schedule.

delete

API Key Scope: task_schedules / destroy

Authorizations
Path parameters
task_idstringRequired

Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID.

Responses
204

Task schedule destroyed.

No content
delete
/tasks/{task_id}/task_schedule
DELETE /api/v2/tasks/{task_id}/task_schedule HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*
204

Task schedule destroyed.

No content

Last updated

Was this helpful?