Run a task

📘
Navigation

Set output destinations via the visual interface

Use output destinations in API calls:

Create a new draft task

Get details of a task

Modify a task

Run a task

Rerun a task

This call runs (executes) the specified task. Only tasks whose status is "DRAFT" can be run.

Request

https://cavatica-api.sbgenomics.com/v2/tasks/{task_id}/actions/run

The task details include its creator, its start and end time, the number of jobs completed in it, and its input and output files. You can also see the status of the task.

Header fields

Name	Description
`X-SBG-Auth-Token` required	Your CAVATICA authentication token.

Path parameters

Name	Data type	Description
`task_id` required	string	The ID of the task you are acting on.

Query parameters

Name	Data type	Description
`fields`	string	Selector specifying a subset of fields to include in the response.
`batch`	boolean	Set this to false to disable the default batching for this task.Running a batch task is a recommended way to run multiple tasks considering the API rate limit.
`use_interruptible_instances`	boolean	This field can be `true` or `false`. Set this field to true to allow the use of spot instances.

Response

See a list of CAVATICA-specific response codes that may be contained in the body of the response.

Example response body

{
    "href": "https://cavatica-api.sbgenomics.com/v2/tasks/ea078c48-12c3-5460-a43b-4a1ab89e7f15",
    "id": "ea078c48-12c3-5460-a43b-4a1ab89e7f15",
    "name": "new name for my task",
    "description": "re-describing the task",
    "status": "RUNNING",
    "project": "RFranklin/my-project",
    "use_interruptible_instances": false,
    "app": "RFranklin/my-project/new/0",
    "type": "v2",
    "created_by": "RFranklin",
    "executed_by": "RFranklin",
    "start_time": "2016-01-12T18:39:30Z",
    "execution_status": {
        "message": "Initializing..."
    },
    "inputs": {
        "dispersion_threshold": null,
        "cuffdiff_zip": {
            "class": "File",
            "path": "567895e6e4b00a1d67a8b1cc",
            "name": "example_human_known_indels.vcf"
        },
        "density_threshold": null,
        "thresholds_off": null
    },
    "outputs": {
        "archive": null,
        "html": null
    },
    "main_location": "volume://rfranklin/task-outputs/mar_19",
    "main_location_alias": "/outputs/<app_name>/mar_19",
    "nodes_override": true,
    "nodes_location": {
        "html": {
            "output_location": "/outputs/<app_name>/mar_19/html_reports"
        },
        "archive": {
            "output_location": "volume://rfranklin/task-outputs/mar_19",
            "output_location_alias": "/outputs/<app_name>/mar_19/vcf"
        }
    }
}