GuidesAPIDatasets HubRelease Notes
API Reference
CGC

List tasks you can access (primary method)

get https://cgc-api.sbgenomics.com/v2/v2/tasks

/tasks

This call returns a list of tasks that you can access. 

https://cgc-api.sbgenomics.com/v2/tasks

Request

Example request

GET /v2/tasks HTTP/1.1
Host: cgc-api.sbgenomics.com
X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74

curl -s -H "X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74" -H "content-type: application/json" -X GET "https://cgc-api.sbgenomics.com/v2/tasks"

Header Fields

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

Query parameters

NameData typeDescription
fieldsstringSelector specifying a subset of fields to include in the response.
statusstringYou can filter the returned tasks by their status. Set the value of status to one of the following values:
"QUEUED"
"DRAFT"
"RUNNING"
"COMPLETED"
"ABORTED"
"FAILED"
parentstringEnter the task ID of the parent task to return all child tasks from that parent.

A parent task is a task that specifies criteria by which to batch its inputs into a series of further sub-tasks, called child tasks.

See the documentation on batching tasks for more details details on how to run tasks in batches.
projectstringEnter the project ID of the project you wish to list the tasks from.
created_fromstringEnter the starting date for querying tasks created on the specified date and onwards (see below for more information).
created_tostringEnter the ending date for querying tasks created until the specified date. You can use it in combination with the created_from to specify a time interval.
started_fromstringEnter the starting date for querying tasks started on the specified date and onwards (see below for more information).
started_tostringEnter the starting date for querying tasks started until the specified date (see below for more information).
ended_fromstringEnter the starting date for querying tasks that ended on a specified date (see below for more information).
ended_tostringEnter the ending date for querying tasks that ended until a specified date.
offsetintegerThe zero-based starting index in the entire collection of the first item to return. The default value is 0. This is a pagination-specific attribute.
limitintegerThe maximum number of collection items to return for a single request. Minimum value is 1. The maximum value is 100 and the default value is 25. This is a pagination-specific attribute.

Using the timestamps

The parameters created_from, created_to, started_from, started_to, ended_from and ended_to are timestamp parameters.

They can be used to query tasks that were created, started, or ended during a specified time interval. All query parameters can be combined.

For example, querying https://cgc-api.sbgenomics.com/v2/tasks?fields=_all&started_from=2016-12-26T12:46:25&ended_to=2016-12-28 will return all tasks which ran between December 26, 2016 at 12:46:25 and December 28.

Furthermore, the timestamp query parameters can be combined with other query parameters. For example, querying https://cgc-api.sbgenomics.com/v2/tasks?fields=_all&created_from=2016-12-26T12:46:25&status=FAILED will return all tasks which were created from December 26 onwards and have failed.

Date format

All dates should be entered using the UTC format (ISO 8601). Allowed formats are:

  1. T<HH:mm:ss>+/-<HH:mm> (use this format to specify the UTC offset, see below)
  2. yyyy-MM-ddTHH:mm:ss
  3. yyyy-MM-dd (when this format is used, the implicit time is 00:00:00)
ParameterDescription
yyyy4 digits for the year (e.g. 2017)
Tspecial character followed by hours and minutes
ss2 digits for seconds (e.g. "25)
MM2 digits for a month (e.g. "02" for February)
mm2 digits for minutes (e.g. "45")
HH2 digits for an hour (e.g. "23")
dd2 digits for a day (e.g. "01")
-UTC - hh:mm
+UTC + hh:mm

UTC offset (HH:mm)

The hours and minutes should be entered the same way as for the date but are used to specify the time offset (e.g. -05:00 = UTC-5). This means you can use your local time to query but have to specify the UTC offset.

Examples:

  1. 2016-04-01T14:25:50+01:00 - Fri Apr 01 13:25:50 UTC 2016
  2. 2016-04-01T14:25:50 - Fri Apr 01 14:25:50 UTC 2016
  3. 2016-04-01 - Fri Apr 01 00:00:00 UTC 2016

Response

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

Example response body

{
  "items": [
    {
      "href": "https://cgc-api.sbgenomics.com/v2/tasks/d54259c2-7fe3-4f87-b4eb-a54847681fc9",
      "id": "d54259c2-7fe3-4f87-b4eb-a54847681fc9",
      "name": "bwa run - 05-11-2015 10:30:59",
      "description": "",
      "status": "Completed"
    }
  ]
}
Language