Modify a task

patch

https://api.sbgenomics.com/v2/tasks/{task_id}

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

task_id

string

required

The ID of the task you are querying.

Query Params

fields

array of strings

Selector specifying a subset of fields to include in the response.

fields

Body Params

name

string

The name of the task

description

string

An optional description of the task

execution_settings

object

inputs

array of objects

See the section on specifying task inputs for information on creating task input objects.

inputs

batch

boolean

This is set to false by default. Set to true to create a batch task and specify the batch_input and batch-by as described below.

batch_input

string

The ID of the input on which you wish to batch. You would typically batch on the input consisting of a list of files. If this parameter is omitted, the default batching criteria defined for the app will be used.

Headers

X-SBG-Auth-Token

string

required

Your Seven Bridges Platform authentication token. For security reasons, token will not be automatically populated in the generated code sample. Please replace <your-token-here> with your token before executing this call.

Response

Language

Loading…

Response

Choose an example:

application/json

200200