Abort a task

/tasks/{task_id}/actions/abort

This call aborts the specified task. Only tasks whose status is "RUNNING" or "QUEUED" may be aborted.

Path

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

Request

Example request

HTTP

POST /v2/tasks/bd5e95d9-12b3-789c-45b6-34d8696571a9/actions/abort" 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 POST "https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/tasks/bd5e95d9-12b3-789c-45b6-34d8696571a9/actions/abort"

Header Fields

Name	Description
X-SBG-Auth-Token required	Your authentication token.

Path parameters

Name	Description
task_id	The ID of the task you are acting on.

Query parameters

Name	Data type	Description
fields	string	Selector 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

JSON

{
  "href": "https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/tasks/bd5e95d9-12b3-789c-45b6-34d8696571a9",
  "id": "bd5e95d9-12b3-789c-45b6-34d8696571a9",
  "name": "Workflow run - 11-15-15 15:56:11",
  "status": "Active",
  "project": "RFranklin/my-project",
  "app": "RFranklin/my-project/workflow/1",
  "created_by": "RFranklin",
  "executed_by": "RFranklin",
  "start_time": "2015-11-15T15:56:11Z",
  "inputs": {
    "my_hardcoded_string": {
      "schema": [
        "null",
        "string"
      ],
      "value": null,
      "errors": null,
      "files": null,
      "missing_files": null
    }
  }
}