Modify task inputs

/tasks/{task_id}/inputs

For general information on the API, including formatting, parameters, and pagination, please see the API Overview.

This call enables you to modify the inputs provided to the specified task. The task is referred to by its ID, which you can obtain by making the call to list all tasks you can access.

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

Request

Example request

GET /v2/tasks/f0b89de2-45b6-789c-12b3-05b832c576c6/inputs HTTP/1.1
Host: cavatica-api.sbgenomics.com
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74
curl  -s -H "X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7" -H "content-type: application/json" -X GET "https://cavatica-api.sbgenomics.com/v2/tasks/f0b89de2-45b6-789c-12b3-05b832c576c6/inputs"

Header Fields

Name

Description

X-SBG-Auth-Token
required

Your CAVATICA authentication token.

Path parameters

Name

Description

task_id
required

The ID of the task you are querying

Query parameters

Name

Data type

Description

fields

string

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

Request body

In the body of the request, you should enter some or all of the key-value pairs contained in the input object for the task. For details about how to specify a task input, see the section of the API Overview on task inputs.

Example request body

{
        "cuffdiff_zip": {
            "class": "File",
            "path": "567890abc3d8130ea4047731",
            "name": "new-file-name.vcf"
        }
}

Response

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

Example response body

{
  "dispersion_threshold": null,
  "cuffdiff_zip": {
    "class": "File",
    "path": "567890abc8a5136ec6127063",
    "name": "new-file-name.vcf"
  },
  "density_threshold": null,
  "thresholds_off": null
}

Language
Click Try It! to start a request and see the response here!