# 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"}}}},"data_management_error":{"description":"Error returned from the data management.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/data_management_error"}}}}},"schemas":{"task_schedule_collection":{"type":"object","properties":{"count":{"type":"integer","readOnly":true},"task_schedules":{"type":"array","readOnly":true,"items":{"$ref":"./data_management/openapi.yaml#/components/schemas/TaskSchedule"}}}},"data_management_error":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"code":{"type":"integer","readOnly":true},"detail":{"type":"string","readOnly":true},"status":{"type":"string","readOnly":true}}}}},"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"},"default":{"$ref":"#/components/responses/data_management_error"}}}}}}
```

## 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":"./data_management/openapi.yaml#/components/schemas/TaskSchedule"}}}},"not_found":{"description":"The requested resource was not found. The detailed error will be of type `not_found`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model_error"}}}},"data_management_error":{"description":"Error returned from the data management.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/data_management_error"}}}}},"schemas":{"model_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"}},"data_management_error":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"code":{"type":"integer","readOnly":true},"detail":{"type":"string","readOnly":true},"status":{"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"},"404":{"$ref":"#/components/responses/not_found"},"default":{"$ref":"#/components/responses/data_management_error"}}}}}}
```

## 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":"./data_management/openapi.yaml#/components/schemas/TaskSchedule"}}}},"unprocessable_entity":{"description":"The received resource was not correctly formatted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model_error"}}}},"data_management_error":{"description":"Error returned from the data management.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/data_management_error"}}}}},"schemas":{"model_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"}},"data_management_error":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"code":{"type":"integer","readOnly":true},"detail":{"type":"string","readOnly":true},"status":{"type":"string","readOnly":true}}}},"requestBodies":{"task_schedule_body":{"content":{"application/json":{"schema":{"$ref":"./data_management/openapi.yaml#/components/schemas/TaskSchedule"}}},"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"},"default":{"$ref":"#/components/responses/data_management_error"}},"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":"./data_management/openapi.yaml#/components/schemas/TaskSchedule"}}}},"unprocessable_entity":{"description":"The received resource was not correctly formatted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model_error"}}}},"data_management_error":{"description":"Error returned from the data management.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/data_management_error"}}}}},"schemas":{"model_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"}},"data_management_error":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"code":{"type":"integer","readOnly":true},"detail":{"type":"string","readOnly":true},"status":{"type":"string","readOnly":true}}}},"requestBodies":{"task_schedule_body":{"content":{"application/json":{"schema":{"$ref":"./data_management/openapi.yaml#/components/schemas/TaskSchedule"}}},"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"},"default":{"$ref":"#/components/responses/data_management_error"}},"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"}},"responses":{"data_management_error":{"description":"Error returned from the data management.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/data_management_error"}}}}},"schemas":{"data_management_error":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"code":{"type":"integer","readOnly":true},"detail":{"type":"string","readOnly":true},"status":{"type":"string","readOnly":true}}}}},"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."},"default":{"$ref":"#/components/responses/data_management_error"}}}}}}
```