Change details of a task

/tasks/{task_id}

This call allows you to change the inputs and parameters of a 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://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/tasks/{task_id}

Request

Example request

GET /v2/tasks/67f68072-45b6-12b3-789c-37be8b0f2f04 HTTP/1.1
Host: api.sb.biodatacatalyst.nhlbi.nih.gov
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74
coming soon!

Example request body

{
 
    "inputs": {
    "infile": {
        "class": "File",
        "path": "567890abc8a5136ec6127063",
         "name": "example_human_known_indels.vcf"
    }
 },
  
"description": "Test",
"name": "test123412wqdq"
}

Header Fields

NameDescription
X-SBG-Auth-Token
required
Your authentication token.

Path parameters

NameDescription
task_id
required
The ID of the task you are changing.
version
required
The version of the task you are changing.

Query parameters

NameData typeDescription
fieldsstringSelector specifying a subset of fields to include in the response.

Response

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

Example response body

{
  "href": "https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/tasks/67f68072-45b6-12b3-789c-37be8b0f2f04",
  "id": "67f68072-45b6-12b3-789c-37be8b0f2f04",
  "name": "testsenad",
  "description": "Test",
  "status": "Active",
  "project": "cwl-abc",
  "app_id": "genomko/cwl-abc/cat/2",
  "created_by": "genomko",
  "start_time": "2015-10-27T15:14:36Z",
  "inputs": {
    "infile": {
      "schema": [
        "null",
        "File"
      ],
      "value": {
        "class": "File",
        "path": "567890abc8a5136ec6127063",
        "name": "example_human_known_indels.vcf"
      },
      "errors": null,
      "files": null,
      "missing_files": null
    },
    "outfile": {
      "schema": [
        "null",
        "string"
      ],
      "value": null,
      "errors": null,
      "files": null,
      "missing_files": null
    }
  }
}