# Task\_callbacks

## Lists all task callbacks.

> \*\*API Key Scope\*\*: task\_callbacks / 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_callbacks_index":{"description":"List of task callbacks.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/task_callback_collection"}}}}},"schemas":{"task_callback_collection":{"type":"object","properties":{"count":{"type":"integer","readOnly":true},"task_callbacks":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/task_callback"}}}},"task_callback":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"format":"int64"},"type":{"type":"string","enum":["filter","after_result_received","before_task_executed","after_task_executed"]},"language":{"type":"string","enum":["javascript","python"]},"script":{"type":"string"}}}},"parameters":{"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"}}}},"paths":{"/tasks/{task_id}/task_callbacks":{"get":{"summary":"Lists all task callbacks.","tags":["task_callbacks"],"operationId":"index_task_callbacks","description":"**API Key Scope**: task_callbacks / index","responses":{"200":{"$ref":"#/components/responses/task_callbacks_index"}},"parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"}]}}}}
```

## Creates a new task callback.

> \*\*API Key Scope\*\*: task\_callbacks / 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_callbacks_show":{"description":"A specific task callback.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/task_callback"}}}},"unprocessable_entity":{"description":"The received resource was not correctly formatted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model_error"}}}}},"schemas":{"task_callback":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"format":"int64"},"type":{"type":"string","enum":["filter","after_result_received","before_task_executed","after_task_executed"]},"language":{"type":"string","enum":["javascript","python"]},"script":{"type":"string"}}},"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"}}},"requestBodies":{"task_callback_body":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/task_callback"}}},"required":true}}},"paths":{"/tasks/{task_id}/task_callbacks":{"post":{"summary":"Creates a new task callback.","operationId":"create_task_callback","description":"**API Key Scope**: task_callbacks / create","tags":["task_callbacks"],"responses":{"201":{"$ref":"#/components/responses/task_callbacks_show"},"422":{"$ref":"#/components/responses/unprocessable_entity"}},"requestBody":{"$ref":"#/components/requestBodies/task_callback_body"}}}}}
```

## Displays a specific task callback.

> \*\*API Key Scope\*\*: task\_callbacks / 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_callbacks_show":{"description":"A specific task callback.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/task_callback"}}}},"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"}}}}},"schemas":{"task_callback":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"format":"int64"},"type":{"type":"string","enum":["filter","after_result_received","before_task_executed","after_task_executed"]},"language":{"type":"string","enum":["javascript","python"]},"script":{"type":"string"}}},"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"}}}},"paths":{"/tasks/{task_id}/task_callbacks/{task_callback_id}":{"get":{"summary":"Displays a specific task callback.","operationId":"show_task_callback","description":"**API Key Scope**: task_callbacks / show","tags":["task_callbacks"],"responses":{"200":{"$ref":"#/components/responses/task_callbacks_show"},"404":{"$ref":"#/components/responses/not_found"}}}}}}
```

## Updates a specific task callback.

> \*\*API Key Scope\*\*: task\_callbacks / 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_callbacks_show":{"description":"A specific task callback.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/task_callback"}}}},"unprocessable_entity":{"description":"The received resource was not correctly formatted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/model_error"}}}}},"schemas":{"task_callback":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"format":"int64"},"type":{"type":"string","enum":["filter","after_result_received","before_task_executed","after_task_executed"]},"language":{"type":"string","enum":["javascript","python"]},"script":{"type":"string"}}},"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"}}},"requestBodies":{"task_callback_body":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/task_callback"}}},"required":true}}},"paths":{"/tasks/{task_id}/task_callbacks/{task_callback_id}":{"put":{"summary":"Updates a specific task callback.","operationId":"update_task_callback","description":"**API Key Scope**: task_callbacks / update","tags":["task_callbacks"],"responses":{"200":{"$ref":"#/components/responses/task_callbacks_show"},"422":{"$ref":"#/components/responses/unprocessable_entity"}},"requestBody":{"$ref":"#/components/requestBodies/task_callback_body"}}}}}
```

## Destroys a specific task callback.

> \*\*API Key Scope\*\*: task\_callbacks / 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_callbacks/{task_callback_id}":{"delete":{"summary":"Destroys a specific task callback.","operationId":"destroy_task_callback","description":"**API Key Scope**: task_callbacks / destroy","tags":["task_callbacks"],"responses":{"204":{"description":"Task callback destroyed."}}}}}}
```