# Tasks
## Lists all tasks.
> \*\*API Key Scope\*\*: tasks / 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":{"tasks_index":{"description":"List of tasks.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/task_collection"}}}}},"schemas":{"task_collection":{"type":"object","properties":{"count":{"type":"integer","readOnly":true},"tasks":{"type":"array","readOnly":true,"items":{"$ref":"#/components/schemas/task"}}}},"task":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"name":{"type":"string"},"comment":{"type":"string"},"workflow_type":{"type":"string","enum":["active_archive","offline_archive","data_exchange","data_migration","maintenance","data_enrichment"]},"workflow_action":{"type":"string","enum":["copy","move","erase","scan","rehydratation","format","check_consistency","duplication","cache_cleaning","ejection","get_index","full_backup","incremental_backup","restore","speedtest"]},"source_type":{"type":"string","enum":["container","primary_nas","secondary_nas","primary_cloud","secondary_cloud","secondary_tape"]},"destination_type":{"type":"string","enum":["container","primary_nas","secondary_nas","primary_cloud","secondary_cloud","secondary_tape"]},"priority":{"type":"integer"},"conflict_resolution":{"type":"string","enum":["rename","overwrite","ignore"]},"action":{"type":"string","readOnly":true,"enum":["noop","run","pause","stop","resume"]},"activate":{"type":"integer"},"creation_date":{"type":"string","readOnly":true,"format":"date-time"},"modification_date":{"type":"string","readOnly":true,"format":"date-time"},"creation_username":{"type":"string","readOnly":true},"modification_username":{"type":"string","readOnly":true},"status":{"type":"string","readOnly":true,"enum":["not_activated","done","in_progress","error","paused","stopped_by_system","in_queue","finished_with_warnings","calculating","stopped_by_user"]},"progress":{"type":"integer"},"job_started":{"type":"string","readOnly":true,"format":"date-time"},"job_finished":{"type":"string","readOnly":true,"format":"date-time"},"processed_size":{"type":"integer","readOnly":true,"format":"int64"},"to_process_size":{"type":"integer","readOnly":true,"format":"int64"},"delete":{"type":"integer"},"local_server_path":{"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"}},"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"}}},"all":{"name":"all","in":"query","description":"For admin only, display also resources by other users.","schema":{"type":"boolean"}},"filter_id":{"name":"id","in":"query","description":"Filter on id","schema":{"type":"string"}},"filter_name":{"name":"name","in":"query","description":"Filter on name","schema":{"type":"string"}},"filter_comment":{"name":"comment","in":"query","description":"Filter on comment","schema":{"type":"string"}},"filter_workflow_type":{"name":"workflow_type","in":"query","description":"Filter on task workflow type","schema":{"type":"string"}},"filter_workflow_action":{"name":"workflow_action","in":"query","description":"Filter on task workflow action","schema":{"type":"string"}},"filter_source_type":{"name":"source_type","in":"query","description":"Filter on task source type","schema":{"type":"string"}},"filter_destination_type":{"name":"destination_type","in":"query","description":"Filter on task destination type","schema":{"type":"string"}},"filter_priority":{"name":"priority","in":"query","description":"Filter on priority","schema":{"type":"string"}},"filter_conflict_resolution":{"name":"conflict_resolution","in":"query","description":"Filter on conflict resolution","schema":{"type":"string"}},"filter_action":{"name":"action","in":"query","description":"Filter on action","schema":{"type":"string"}},"filter_activate":{"name":"activate","in":"query","description":"Filter on activate","schema":{"type":"string"}},"filter_creation_date":{"name":"creation_date","in":"query","description":"Filter on creation date","schema":{"type":"string"}},"filter_creation_username":{"name":"creation_username","in":"query","description":"Filter on creation username","schema":{"type":"string"}},"filter_modification_date":{"name":"modification_date","in":"query","description":"Filter on modification date","schema":{"type":"string"}},"filter_modification_username":{"name":"modification_username","in":"query","description":"Filter on modification username","schema":{"type":"string"}},"filter_job_started":{"name":"job_started","in":"query","description":"Filter on job started","schema":{"type":"string"}},"filter_job_finished":{"name":"job_finished","in":"query","description":"Filter on job finished","schema":{"type":"string"}},"filter_status":{"name":"status","in":"query","description":"Filter on status","schema":{"type":"string"}},"filter_processed_size":{"name":"processed_size","in":"query","description":"Filter on processed size","schema":{"type":"string"}},"filter_to_process_size":{"name":"to_process_size","in":"query","description":"Filter on to process size","schema":{"type":"string"}},"filter_source_pool_id":{"name":"source_pool_id","in":"query","description":"Filter on task source pool id","schema":{"type":"string"}},"filter_source_pool_name":{"name":"source_pool_name","in":"query","description":"Filter on task source pool name","schema":{"type":"string"}},"filter_source_tape_id":{"name":"source_tape_id","in":"query","description":"Filter on task source tape id","schema":{"type":"string"}},"filter_source_tape_barcode":{"name":"source_tape_barcode","in":"query","description":"Filter on task source tape barcode","schema":{"type":"string"}},"filter_destination_pool_id":{"name":"destination_pool_id","in":"query","description":"Filter on task destination pool id","schema":{"type":"string"}},"filter_destination_pool_name":{"name":"destination_pool_name","in":"query","description":"Filter on task destination pool name","schema":{"type":"string"}},"filter_destination_tape_id":{"name":"destination_tape_id","in":"query","description":"Filter on task destination tape id","schema":{"type":"string"}},"filter_destination_tape_barcode":{"name":"destination_tape_barcode","in":"query","description":"Filter on task destination tape barcode","schema":{"type":"string"}}}},"paths":{"/tasks":{"get":{"summary":"Lists all tasks.","tags":["tasks"],"operationId":"index_tasks","description":"**API Key Scope**: tasks / index","responses":{"200":{"$ref":"#/components/responses/tasks_index"}},"parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/sort_by"},{"$ref":"#/components/parameters/all"},{"$ref":"#/components/parameters/filter_id"},{"$ref":"#/components/parameters/filter_name"},{"$ref":"#/components/parameters/filter_comment"},{"$ref":"#/components/parameters/filter_workflow_type"},{"$ref":"#/components/parameters/filter_workflow_action"},{"$ref":"#/components/parameters/filter_source_type"},{"$ref":"#/components/parameters/filter_destination_type"},{"$ref":"#/components/parameters/filter_priority"},{"$ref":"#/components/parameters/filter_conflict_resolution"},{"$ref":"#/components/parameters/filter_action"},{"$ref":"#/components/parameters/filter_activate"},{"$ref":"#/components/parameters/filter_creation_date"},{"$ref":"#/components/parameters/filter_creation_username"},{"$ref":"#/components/parameters/filter_modification_date"},{"$ref":"#/components/parameters/filter_modification_username"},{"$ref":"#/components/parameters/filter_job_started"},{"$ref":"#/components/parameters/filter_job_finished"},{"$ref":"#/components/parameters/filter_status"},{"$ref":"#/components/parameters/filter_processed_size"},{"$ref":"#/components/parameters/filter_to_process_size"},{"$ref":"#/components/parameters/filter_source_pool_id"},{"$ref":"#/components/parameters/filter_source_pool_name"},{"$ref":"#/components/parameters/filter_source_tape_id"},{"$ref":"#/components/parameters/filter_source_tape_barcode"},{"$ref":"#/components/parameters/filter_destination_pool_id"},{"$ref":"#/components/parameters/filter_destination_pool_name"},{"$ref":"#/components/parameters/filter_destination_tape_id"},{"$ref":"#/components/parameters/filter_destination_tape_barcode"}]}}}}
```
## Creates a new task.
> \*\*API Key Scope\*\*: tasks / 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":{"tasks_show":{"description":"A specific task.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/task"}}}},"unprocessable_entity":{"description":"The received resource was not correctly formatted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"schemas":{"task":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"name":{"type":"string"},"comment":{"type":"string"},"workflow_type":{"type":"string","enum":["active_archive","offline_archive","data_exchange","data_migration","maintenance","data_enrichment"]},"workflow_action":{"type":"string","enum":["copy","move","erase","scan","rehydratation","format","check_consistency","duplication","cache_cleaning","ejection","get_index","full_backup","incremental_backup","restore","speedtest"]},"source_type":{"type":"string","enum":["container","primary_nas","secondary_nas","primary_cloud","secondary_cloud","secondary_tape"]},"destination_type":{"type":"string","enum":["container","primary_nas","secondary_nas","primary_cloud","secondary_cloud","secondary_tape"]},"priority":{"type":"integer"},"conflict_resolution":{"type":"string","enum":["rename","overwrite","ignore"]},"action":{"type":"string","readOnly":true,"enum":["noop","run","pause","stop","resume"]},"activate":{"type":"integer"},"creation_date":{"type":"string","readOnly":true,"format":"date-time"},"modification_date":{"type":"string","readOnly":true,"format":"date-time"},"creation_username":{"type":"string","readOnly":true},"modification_username":{"type":"string","readOnly":true},"status":{"type":"string","readOnly":true,"enum":["not_activated","done","in_progress","error","paused","stopped_by_system","in_queue","finished_with_warnings","calculating","stopped_by_user"]},"progress":{"type":"integer"},"job_started":{"type":"string","readOnly":true,"format":"date-time"},"job_finished":{"type":"string","readOnly":true,"format":"date-time"},"processed_size":{"type":"integer","readOnly":true,"format":"int64"},"to_process_size":{"type":"integer","readOnly":true,"format":"int64"},"delete":{"type":"integer"},"local_server_path":{"type":"string"}}},"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_body":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/task"}}},"required":true}}},"paths":{"/tasks":{"post":{"summary":"Creates a new task.","operationId":"create_task","description":"**API Key Scope**: tasks / create\n","tags":["tasks"],"responses":{"201":{"$ref":"#/components/responses/tasks_show"},"422":{"$ref":"#/components/responses/unprocessable_entity"}},"requestBody":{"$ref":"#/components/requestBodies/task_body"}}}}}
```
## Displays a specific task.
> \*\*API Key Scope\*\*: tasks / 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":{"tasks_show":{"description":"A specific task.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/task"}}}}},"schemas":{"task":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"name":{"type":"string"},"comment":{"type":"string"},"workflow_type":{"type":"string","enum":["active_archive","offline_archive","data_exchange","data_migration","maintenance","data_enrichment"]},"workflow_action":{"type":"string","enum":["copy","move","erase","scan","rehydratation","format","check_consistency","duplication","cache_cleaning","ejection","get_index","full_backup","incremental_backup","restore","speedtest"]},"source_type":{"type":"string","enum":["container","primary_nas","secondary_nas","primary_cloud","secondary_cloud","secondary_tape"]},"destination_type":{"type":"string","enum":["container","primary_nas","secondary_nas","primary_cloud","secondary_cloud","secondary_tape"]},"priority":{"type":"integer"},"conflict_resolution":{"type":"string","enum":["rename","overwrite","ignore"]},"action":{"type":"string","readOnly":true,"enum":["noop","run","pause","stop","resume"]},"activate":{"type":"integer"},"creation_date":{"type":"string","readOnly":true,"format":"date-time"},"modification_date":{"type":"string","readOnly":true,"format":"date-time"},"creation_username":{"type":"string","readOnly":true},"modification_username":{"type":"string","readOnly":true},"status":{"type":"string","readOnly":true,"enum":["not_activated","done","in_progress","error","paused","stopped_by_system","in_queue","finished_with_warnings","calculating","stopped_by_user"]},"progress":{"type":"integer"},"job_started":{"type":"string","readOnly":true,"format":"date-time"},"job_finished":{"type":"string","readOnly":true,"format":"date-time"},"processed_size":{"type":"integer","readOnly":true,"format":"int64"},"to_process_size":{"type":"integer","readOnly":true,"format":"int64"},"delete":{"type":"integer"},"local_server_path":{"type":"string"}}}}},"paths":{"/tasks/{task_id}":{"get":{"summary":"Displays a specific task.","operationId":"show_task","description":"**API Key Scope**: tasks / show","tags":["tasks"],"responses":{"200":{"$ref":"#/components/responses/tasks_show"}}}}}}
```
## Updates a specific task.
> \*\*API Key Scope\*\*: tasks / 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":{"tasks_show":{"description":"A specific task.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/task"}}}},"unprocessable_entity":{"description":"The received resource was not correctly formatted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/error"}}}}},"schemas":{"task":{"type":"object","properties":{"id":{"type":"integer","readOnly":true,"format":"int64"},"name":{"type":"string"},"comment":{"type":"string"},"workflow_type":{"type":"string","enum":["active_archive","offline_archive","data_exchange","data_migration","maintenance","data_enrichment"]},"workflow_action":{"type":"string","enum":["copy","move","erase","scan","rehydratation","format","check_consistency","duplication","cache_cleaning","ejection","get_index","full_backup","incremental_backup","restore","speedtest"]},"source_type":{"type":"string","enum":["container","primary_nas","secondary_nas","primary_cloud","secondary_cloud","secondary_tape"]},"destination_type":{"type":"string","enum":["container","primary_nas","secondary_nas","primary_cloud","secondary_cloud","secondary_tape"]},"priority":{"type":"integer"},"conflict_resolution":{"type":"string","enum":["rename","overwrite","ignore"]},"action":{"type":"string","readOnly":true,"enum":["noop","run","pause","stop","resume"]},"activate":{"type":"integer"},"creation_date":{"type":"string","readOnly":true,"format":"date-time"},"modification_date":{"type":"string","readOnly":true,"format":"date-time"},"creation_username":{"type":"string","readOnly":true},"modification_username":{"type":"string","readOnly":true},"status":{"type":"string","readOnly":true,"enum":["not_activated","done","in_progress","error","paused","stopped_by_system","in_queue","finished_with_warnings","calculating","stopped_by_user"]},"progress":{"type":"integer"},"job_started":{"type":"string","readOnly":true,"format":"date-time"},"job_finished":{"type":"string","readOnly":true,"format":"date-time"},"processed_size":{"type":"integer","readOnly":true,"format":"int64"},"to_process_size":{"type":"integer","readOnly":true,"format":"int64"},"delete":{"type":"integer"},"local_server_path":{"type":"string"}}},"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_body":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/task"}}},"required":true}}},"paths":{"/tasks/{task_id}":{"put":{"summary":"Updates a specific task.","operationId":"update_task","description":"**API Key Scope**: tasks / update","tags":["tasks"],"responses":{"200":{"$ref":"#/components/responses/tasks_show"},"422":{"$ref":"#/components/responses/unprocessable_entity"}},"requestBody":{"$ref":"#/components/requestBodies/task_body"}}}}}
```
## Destroys a specific task.
> \*\*API Key Scope\*\*: tasks / 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}":{"delete":{"summary":"Destroys a specific task.","operationId":"destroy_task","description":"**API Key Scope**: tasks / destroy","tags":["tasks"],"responses":{"204":{"description":"Task destroyed."}}}}}}
```
## Check result of a task run request.
> \*\*API Key Scope\*\*: tasks / action
```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":{"active_job_status":{"description":"An active job that may be queued, working, completed or failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/active_job_status"}}}}},"schemas":{"active_job_status":{"type":"object","properties":{"job_id":{"type":"string","readOnly":true},"status":{"type":"string","readOnly":true,"enum":["queued","working","completed","failed"]},"progress":{"type":"integer","readOnly":true},"total":{"type":"integer","readOnly":true}}}},"parameters":{"job_id":{"name":"job_id","in":"query","description":"ID of active job","required":true,"schema":{"type":"string"}}}},"paths":{"/tasks/{task_id}/action/run":{"get":{"summary":"Check result of a task run request.","operationId":"run_task_result","tags":["tasks"],"description":"**API Key Scope**: tasks / action","responses":{"200":{"$ref":"#/components/responses/active_job_status"},"202":{"$ref":"#/components/responses/active_job_status"}},"parameters":[{"$ref":"#/components/parameters/job_id"}]}}}}
```
## Run a task.
> \*\*API Key Scope\*\*: tasks / action
```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":{"active_job_status":{"description":"An active job that may be queued, working, completed or failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/active_job_status"}}}}},"schemas":{"active_job_status":{"type":"object","properties":{"job_id":{"type":"string","readOnly":true},"status":{"type":"string","readOnly":true,"enum":["queued","working","completed","failed"]},"progress":{"type":"integer","readOnly":true},"total":{"type":"integer","readOnly":true}}}}},"paths":{"/tasks/{task_id}/action/run":{"put":{"summary":"Run a task.","operationId":"run_task","description":"**API Key Scope**: tasks / action","tags":["tasks"],"responses":{"202":{"$ref":"#/components/responses/active_job_status"}}}}}}
```
## Check result of a task pause request.
> \*\*API Key Scope\*\*: tasks / action
```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":{"active_job_status":{"description":"An active job that may be queued, working, completed or failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/active_job_status"}}}}},"schemas":{"active_job_status":{"type":"object","properties":{"job_id":{"type":"string","readOnly":true},"status":{"type":"string","readOnly":true,"enum":["queued","working","completed","failed"]},"progress":{"type":"integer","readOnly":true},"total":{"type":"integer","readOnly":true}}}},"parameters":{"job_id":{"name":"job_id","in":"query","description":"ID of active job","required":true,"schema":{"type":"string"}}}},"paths":{"/tasks/{task_id}/action/pause":{"get":{"summary":"Check result of a task pause request.","operationId":"pause_task_result","tags":["tasks"],"description":"**API Key Scope**: tasks / action","responses":{"200":{"$ref":"#/components/responses/active_job_status"},"202":{"$ref":"#/components/responses/active_job_status"}},"parameters":[{"$ref":"#/components/parameters/job_id"}]}}}}
```
## Pause a task.
> \*\*API Key Scope\*\*: tasks / action
```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":{"active_job_status":{"description":"An active job that may be queued, working, completed or failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/active_job_status"}}}}},"schemas":{"active_job_status":{"type":"object","properties":{"job_id":{"type":"string","readOnly":true},"status":{"type":"string","readOnly":true,"enum":["queued","working","completed","failed"]},"progress":{"type":"integer","readOnly":true},"total":{"type":"integer","readOnly":true}}}}},"paths":{"/tasks/{task_id}/action/pause":{"put":{"summary":"Pause a task.","operationId":"pause_task","description":"**API Key Scope**: tasks / action","tags":["tasks"],"responses":{"202":{"$ref":"#/components/responses/active_job_status"}}}}}}
```
## Check result of a task stop request.
> \*\*API Key Scope\*\*: tasks / action
```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":{"active_job_status":{"description":"An active job that may be queued, working, completed or failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/active_job_status"}}}}},"schemas":{"active_job_status":{"type":"object","properties":{"job_id":{"type":"string","readOnly":true},"status":{"type":"string","readOnly":true,"enum":["queued","working","completed","failed"]},"progress":{"type":"integer","readOnly":true},"total":{"type":"integer","readOnly":true}}}},"parameters":{"job_id":{"name":"job_id","in":"query","description":"ID of active job","required":true,"schema":{"type":"string"}}}},"paths":{"/tasks/{task_id}/action/stop":{"get":{"summary":"Check result of a task stop request.","operationId":"stop_task_result","tags":["tasks"],"description":"**API Key Scope**: tasks / action","responses":{"200":{"$ref":"#/components/responses/active_job_status"},"202":{"$ref":"#/components/responses/active_job_status"}},"parameters":[{"$ref":"#/components/parameters/job_id"}]}}}}
```
## Stop a task.
> \*\*API Key Scope\*\*: tasks / action
```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":{"active_job_status":{"description":"An active job that may be queued, working, completed or failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/active_job_status"}}}}},"schemas":{"active_job_status":{"type":"object","properties":{"job_id":{"type":"string","readOnly":true},"status":{"type":"string","readOnly":true,"enum":["queued","working","completed","failed"]},"progress":{"type":"integer","readOnly":true},"total":{"type":"integer","readOnly":true}}}}},"paths":{"/tasks/{task_id}/action/stop":{"put":{"summary":"Stop a task.","operationId":"stop_task","description":"**API Key Scope**: tasks / action","tags":["tasks"],"responses":{"202":{"$ref":"#/components/responses/active_job_status"}}}}}}
```
## Check result of a task resume request.
> \*\*API Key Scope\*\*: tasks / action
```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":{"active_job_status":{"description":"An active job that may be queued, working, completed or failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/active_job_status"}}}}},"schemas":{"active_job_status":{"type":"object","properties":{"job_id":{"type":"string","readOnly":true},"status":{"type":"string","readOnly":true,"enum":["queued","working","completed","failed"]},"progress":{"type":"integer","readOnly":true},"total":{"type":"integer","readOnly":true}}}},"parameters":{"job_id":{"name":"job_id","in":"query","description":"ID of active job","required":true,"schema":{"type":"string"}}}},"paths":{"/tasks/{task_id}/action/resume":{"get":{"summary":"Check result of a task resume request.","operationId":"resume_task_result","tags":["tasks"],"description":"**API Key Scope**: tasks / action","responses":{"200":{"$ref":"#/components/responses/active_job_status"},"202":{"$ref":"#/components/responses/active_job_status"}},"parameters":[{"$ref":"#/components/parameters/job_id"}]}}}}
```
## Resume a task.
> \*\*API Key Scope\*\*: tasks / action
```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":{"active_job_status":{"description":"An active job that may be queued, working, completed or failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/active_job_status"}}}}},"schemas":{"active_job_status":{"type":"object","properties":{"job_id":{"type":"string","readOnly":true},"status":{"type":"string","readOnly":true,"enum":["queued","working","completed","failed"]},"progress":{"type":"integer","readOnly":true},"total":{"type":"integer","readOnly":true}}}}},"paths":{"/tasks/{task_id}/action/resume":{"put":{"summary":"Resume a task.","operationId":"resume_task","description":"**API Key Scope**: tasks / action","tags":["tasks"],"responses":{"202":{"$ref":"#/components/responses/active_job_status"}}}}}}
```
---
# 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/tasks.md?ask=
```
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.