Modify a task

Change the details of the specified task, including its name, description, and inputs. The task is referred to by its ID, which you can obtain by making the call to list all tasks you can access.

Note that you can only modify tasks with a task status of DRAFT. Tasks which are RUNNING, QUEUED, ABORTED, COMPLETED or FAILEDcannot be modified in order to enable the reproducibility of analyses which have been queued for execution or has initiated executing.

See the section on task inputs for details on how to refer to a task's inputs.

πŸ“˜

If you are using Seven Bridges Platform EU, please use the following endpoint: https://eu-api.sbgenomics.com/v2/tasks/{task_id}

There are two things to note if you are editing a batch task:

  1. If you want to change the input on which to batch and the batch criteria, you need to specify the batch_input and batch_by parameters together in the same PATCH request.

  2. If you want to disable batching on a task, set batch to false. Or, you can also set the parameters batch_input and batch_by to null.

{
    "batch":false 
}

Example request body

{   "description": "my draft task",
    "name": "RFranklin, Experiment IV",
        "use_interruptible_instances": false,
    "execution_settings": {
            "instance_type": "c4.2xlarge;ebs-gp2;2000",
            "max_parallel_instances": 1
        },
    "inputs": {
        "cuffdiff_zip": {
            "class": "File",
            "path": "567890abc9b0307bc0414164",
            "name": "example_human_known_indels.vcf"
        }
    }
}

Response

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

Language