# Task\_schedules

## Lists all task schedules.

> \*\*API Key Scope\*\*: task\_schedules / index

```json
{"openapi":"3.0.1","info":{"title":"Nodeum API","version":"2.1.0"},"servers":[{"url":"{url}/api/v2","variables":{"url":{"default":"http://localhost","description":"URL of server"}}}],"security":[{"BasicAuth":[]},{"BearerAuth":[]},{"JWT":[]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic","description":"Pass the username and password of a user in the authorization header.\nThis currently gives full access."},"BearerAuth":{"type":"apiKey","description":"Create an API Key associated to user.\nAccess can be restricted with the scope.\nEach API call described below has a scoped mentionned in its description.\n\nFor example :\n\n**API Key Scope**: files / index\n\nThis means that the API key should have a scope with controller as *files*\nand the action as *index*.","name":"Authorization","in":"header"},"JWT":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"responses":{"task_schedules_index":{"description":"List of task schedules.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/task_schedule_collection"}}}}},"schemas":{"task_schedule_collection":{"type":"object","properties":{"count":{"type":"integer","readOnly":true},"task_schedules":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/task_schedule"}}}},"task_schedule":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"task_id":{"type":"integer","format":"int64"},"rrule":{"type":"string"},"done":{"type":"boolean"},"next":{"type":"string","readOnly":true},"missed_count":{"type":"integer","readOnly":true},"skipped_count":{"type":"integer","readOnly":true},"missed_last":{"type":"string","readOnly":true},"missed_first":{"type":"string","readOnly":true}}}},"parameters":{"with_next_schedule":{"name":"with_next","in":"query","description":"Display the next scheduled date, and information about missing executions.","schema":{"type":"boolean","default":true}},"limit":{"name":"limit","in":"query","description":"The number of items to display for pagination.","schema":{"type":"integer"}},"offset":{"name":"offset","in":"query","description":"The number of items to skip for pagination.","schema":{"type":"integer"}},"sort_by":{"name":"sort_by","in":"query","description":"Sort results by attribute.\n\nCan sort on multiple attributes, separated by `|`.\nOrder direction can be suffixing the attribute by either `:asc` (default) or `:desc`.","style":"pipeDelimited","schema":{"type":"array","items":{"type":"string"}}},"filter_id":{"name":"id","in":"query","description":"Filter on id","schema":{"type":"string"}},"filter_rrule":{"name":"rrule","in":"query","description":"Filter on RRule of schedule","schema":{"type":"string"}},"filter_done":{"name":"done","in":"query","description":"Filter on done schedule","schema":{"type":"string"}},"filter_task_id":{"name":"task_id","in":"query","description":"Filter on task id","schema":{"type":"string"}}}},"paths":{"/task_schedules":{"get":{"summary":"Lists all task schedules.","tags":["task_schedules"],"operationId":"index_task_schedules","description":"**API Key Scope**: task_schedules / index","responses":{"200":{"$ref":"#/components/responses/task_schedules_index"}},"parameters":[{"$ref":"#/components/parameters/with_next_schedule"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/sort_by"},{"$ref":"#/components/parameters/filter_id"},{"$ref":"#/components/parameters/filter_rrule"},{"$ref":"#/components/parameters/filter_done"},{"$ref":"#/components/parameters/filter_task_id"}]}}}}
```

## Displays the task schedule.

> \*\*API Key Scope\*\*: task\_schedules / show

```json
{"openapi":"3.0.1","info":{"title":"Nodeum API","version":"2.1.0"},"servers":[{"url":"{url}/api/v2","variables":{"url":{"default":"http://localhost","description":"URL of server"}}}],"security":[{"BasicAuth":[]},{"BearerAuth":[]},{"JWT":[]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic","description":"Pass the username and password of a user in the authorization header.\nThis currently gives full access."},"BearerAuth":{"type":"apiKey","description":"Create an API Key associated to user.\nAccess can be restricted with the scope.\nEach API call described below has a scoped mentionned in its description.\n\nFor example :\n\n**API Key Scope**: files / index\n\nThis means that the API key should have a scope with controller as *files*\nand the action as *index*.","name":"Authorization","in":"header"},"JWT":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"responses":{"task_schedule_show":{"description":"A specific task schedule.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/task_schedule"}}}}},"schemas":{"task_schedule":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"task_id":{"type":"integer","format":"int64"},"rrule":{"type":"string"},"done":{"type":"boolean"},"next":{"type":"string","readOnly":true},"missed_count":{"type":"integer","readOnly":true},"skipped_count":{"type":"integer","readOnly":true},"missed_last":{"type":"string","readOnly":true},"missed_first":{"type":"string","readOnly":true}}}}},"paths":{"/tasks/{task_id}/task_schedule":{"get":{"summary":"Displays the task schedule.","operationId":"show_task_schedule","description":"**API Key Scope**: task_schedules / show","tags":["task_schedules"],"responses":{"200":{"$ref":"#/components/responses/task_schedule_show"}}}}}}
```

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

> \*\*API Key Scope\*\*: task\_schedules / create

```json
{"openapi":"3.0.1","info":{"title":"Nodeum API","version":"2.1.0"},"servers":[{"url":"{url}/api/v2","variables":{"url":{"default":"http://localhost","description":"URL of server"}}}],"security":[{"BasicAuth":[]},{"BearerAuth":[]},{"JWT":[]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic","description":"Pass the username and password of a user in the authorization header.\nThis currently gives full access."},"BearerAuth":{"type":"apiKey","description":"Create an API Key associated to user.\nAccess can be restricted with the scope.\nEach API call described below has a scoped mentionned in its description.\n\nFor example :\n\n**API Key Scope**: files / index\n\nThis means that the API key should have a scope with controller as *files*\nand the action as *index*.","name":"Authorization","in":"header"},"JWT":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"responses":{"task_schedule_show":{"description":"A specific task schedule.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/task_schedule"}}}},"unprocessable_entity":{"description":"The received resource was not correctly formatted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"schemas":{"task_schedule":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"task_id":{"type":"integer","format":"int64"},"rrule":{"type":"string"},"done":{"type":"boolean"},"next":{"type":"string","readOnly":true},"missed_count":{"type":"integer","readOnly":true},"skipped_count":{"type":"integer","readOnly":true},"missed_last":{"type":"string","readOnly":true},"missed_first":{"type":"string","readOnly":true}}},"error":{"type":"object","properties":{"details":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/attribute_error"}},"description":"Parsable objects describing the errors. The key is the invalid attribute name."},"messages":{"type":"array","description":"English description of the errors.","items":{"type":"string"}}}},"attribute_error":{"required":["error"],"type":"object","properties":{"error":{"type":"string"}},"discriminator":{"propertyName":"error"}}},"requestBodies":{"task_schedule_body":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/task_schedule"}}},"required":true}}},"paths":{"/tasks/{task_id}/task_schedule":{"post":{"summary":"Creates a new task schedule. Only one should be created.","operationId":"create_task_schedule","description":"**API Key Scope**: task_schedules / create","tags":["task_schedules"],"responses":{"201":{"$ref":"#/components/responses/task_schedule_show"},"422":{"$ref":"#/components/responses/unprocessable_entity"}},"requestBody":{"$ref":"#/components/requestBodies/task_schedule_body"}}}}}
```

## Updates the existing task schedule.

> \*\*API Key Scope\*\*: task\_schedules / update

```json
{"openapi":"3.0.1","info":{"title":"Nodeum API","version":"2.1.0"},"servers":[{"url":"{url}/api/v2","variables":{"url":{"default":"http://localhost","description":"URL of server"}}}],"security":[{"BasicAuth":[]},{"BearerAuth":[]},{"JWT":[]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic","description":"Pass the username and password of a user in the authorization header.\nThis currently gives full access."},"BearerAuth":{"type":"apiKey","description":"Create an API Key associated to user.\nAccess can be restricted with the scope.\nEach API call described below has a scoped mentionned in its description.\n\nFor example :\n\n**API Key Scope**: files / index\n\nThis means that the API key should have a scope with controller as *files*\nand the action as *index*.","name":"Authorization","in":"header"},"JWT":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"responses":{"task_schedule_show":{"description":"A specific task schedule.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/task_schedule"}}}},"unprocessable_entity":{"description":"The received resource was not correctly formatted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"schemas":{"task_schedule":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"task_id":{"type":"integer","format":"int64"},"rrule":{"type":"string"},"done":{"type":"boolean"},"next":{"type":"string","readOnly":true},"missed_count":{"type":"integer","readOnly":true},"skipped_count":{"type":"integer","readOnly":true},"missed_last":{"type":"string","readOnly":true},"missed_first":{"type":"string","readOnly":true}}},"error":{"type":"object","properties":{"details":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/attribute_error"}},"description":"Parsable objects describing the errors. The key is the invalid attribute name."},"messages":{"type":"array","description":"English description of the errors.","items":{"type":"string"}}}},"attribute_error":{"required":["error"],"type":"object","properties":{"error":{"type":"string"}},"discriminator":{"propertyName":"error"}}},"requestBodies":{"task_schedule_body":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/task_schedule"}}},"required":true}}},"paths":{"/tasks/{task_id}/task_schedule":{"put":{"summary":"Updates the existing task schedule.","operationId":"update_task_schedule","description":"**API Key Scope**: task_schedules / update","tags":["task_schedules"],"responses":{"200":{"$ref":"#/components/responses/task_schedule_show"},"422":{"$ref":"#/components/responses/unprocessable_entity"}},"requestBody":{"$ref":"#/components/requestBodies/task_schedule_body"}}}}}
```

## Destroys the task schedule.

> \*\*API Key Scope\*\*: task\_schedules / destroy

```json
{"openapi":"3.0.1","info":{"title":"Nodeum API","version":"2.1.0"},"servers":[{"url":"{url}/api/v2","variables":{"url":{"default":"http://localhost","description":"URL of server"}}}],"security":[{"BasicAuth":[]},{"BearerAuth":[]},{"JWT":[]}],"components":{"securitySchemes":{"BasicAuth":{"type":"http","scheme":"basic","description":"Pass the username and password of a user in the authorization header.\nThis currently gives full access."},"BearerAuth":{"type":"apiKey","description":"Create an API Key associated to user.\nAccess can be restricted with the scope.\nEach API call described below has a scoped mentionned in its description.\n\nFor example :\n\n**API Key Scope**: files / index\n\nThis means that the API key should have a scope with controller as *files*\nand the action as *index*.","name":"Authorization","in":"header"},"JWT":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}}},"paths":{"/tasks/{task_id}/task_schedule":{"delete":{"summary":"Destroys the task schedule.","operationId":"destroy_task_schedule","description":"**API Key Scope**: task_schedules / destroy","tags":["task_schedules"],"responses":{"204":{"description":"Task schedule destroyed."}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.nodeum.io/data-archiving/api-developers/api-reference-nodeum-data-archiving/task_schedules.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.