Modify task inputs

/tasks/{task_id}/inputs

This call returns enables the user to change just 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.

Path

https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/tasks/{task_id}/inputs

Request

Example request

HTTP

PATCH /v2/tasks/723c949a-789c-12b3-45b6-b2dd0d8d0021/inputs HTTP/1.1
Host: api.sb.biodatacatalyst.nhlbi.nih.gov
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74

cURL

curl  -s -H "X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7" -H "content-type: application/json" -X PATCH "https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/tasks/723c949a-789c-12b3-45b6-b2dd0d8d0021/inputs"

Header Fields

Name	Description
X-SBG-Auth-Token required	Your 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

JSON

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

Response

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

Example response body

JSON

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