Platform documentationDatasetsAPIs
APIs
Log in to Seven Bridges Platform

List tasks you can access

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

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

If you are using Seven Bridges Platform EU, please use the following endpoint: https://eu-api.sbgenomics.com/v2/tasks

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://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://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. <yyyy-MM-dd>T&lt;HH:mm:ss>+/-&lt;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 Seven Bridges Platform-specific response codes that may be contained in the body of the response.

Query Params
fields
array of strings

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

fields
string

You 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"

string

Enter 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 on how to run tasks in batches.

string

Enter the project ID of the project you wish to list the tasks from.

date-time

Enter the starting date for querying tasks created on the specified date and onwards (see below for more information).

date-time

Enter the ending date for querying tasks created until the specified date. You can use it in combination with created_from to specify a time interval.

date-time

Enter the starting date for querying tasks started on the specified date and onwards (see below for more information).

date-time

Enter the starting date for querying tasks started until the specified date (see below for more information).

date-time

Enter the starting date for querying tasks that ended on a specified date (see below for more information).

date-time

Enter the ending date for querying tasks that ended until a specified date.

string

Order returned results by the specified field. Allowed values: - created_time - start_time - name - end_time - created_by Sort can be done only by one column. The default value is created_time.

string

Sort results in ascending or descending order by specifying asc or desc, respectively. Only taken into account if order_by is explicitly specified. The default value is asc.

string

Enter an automation run ID to list all tasks created from the specified automation run.

Headers
string
required

Your Seven Bridges Platform authentication token. For security reasons, token will not be automatically populated in the generated code sample. Please replace <your-token-here> with your token before executing this call.

Response

Updated 8 months ago

Language
LoadingLoading…
Response
Choose an example:
application/json

Updated 8 months ago