Seven Bridges knowledge centerDocumentation
API Reference
Start typing to search…

List all datasets

❗️

Heads Up!

This page documents the Advanced Access version (think "beta" but with fewer bugs) of the Datasets API functionality.

This call returns either the list of all public datasets on CAVATICA or all datasets you are a member of:

  • To list all public datasets, use the visibility query parameter and set it to public.
  • To list all datasets you are a member of, omit the visibility query parameter.

For each dataset an ID,name and URL on CAVATICA will be returned.

https://cavatica-api.sbgenomics.com/v2/datasets

Request

Example request

GET /v2/datasets/
Host: cavatica-api.sbgenomics.com
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74
Content-Type: application/json
X-SBG-advance-access: advance
curl -X GET -H "X-SBG-Auth-Token: 5f2d7a4d8186488694fa3dc3844b7b06" -H "x-sbg-advance-access: advance" -H "Content-Type: application/json" "https://cavatica-api.sbgenomics.com/v2/datasets"

Header fields

Name

Description

X-SBG-Auth-Token required

Your CAVATICA authentication token.

X-SBG-Advance-Access
required

advance

Query parameters

Name

Data type

Description

'visibility'

string

Use this parameter and set it to public if you want to list all public datasets on CAVATICA.

Response

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

Example response body

{
  "href": "http://cavatica-api.sbgenomics.com/v2/datasets/?offset=0&limit=7",
  "items": [
    {
      "href": "http://cavatica-api.sbgenomics.com/v2/datasets/rfranklin/target-aml-pa-01",
      "id": "rfranklin/target-aml-pa-01",
      "name": "TARGET_AML_PA_01"
    },
    {
      "href": "http://cavatica-api.sbgenomics.com/v2/datasets/rfranklin/pnoc-dipg-pa-02",
      "id": "rfranklin/pnoc-dipg-pa-02",
      "name": "PNOC_DIPG_PA_02"
    },
    {
      "href": "http://cavatica-api.sbgenomics.com/v2/datasets/rfranklin/pcgc-chd-pa-01",
      "id": "rfranklin/pcgc-chd-pa-01",
      "name": "PCGC_CHD_PA_01"
    },
    {
      "href": "http://cavatica-api.sbgenomics.com/v2/datasets/cavatica/cca-mixed-pa-01",
      "id": "cavatica/cca-mixed-pa-01",
      "name": "CCA_MIXED_PA_01"
    },
    {
      "href": "http://cavatica-api.sbgenomics.com/v2/datasets/cavatica/cca-rhb-pa-01",
      "id": "cavatica/cca-rhb-pa-01",
      "name": "CCA_RHB_PA_01"
    },
    {
      "href": "http://cavatica-api.sbgenomics.com/v2/datasets/cavatica/cca-os-pa-01",
      "id": "cavatica/cca-os-pa-01",
      "name": "CCA_OS_PA_01"
    },
    {
      "href": "http://cavatica-api.sbgenomics.com/v2/datasets/cavatica/cca-rb-pa-01",
      "id": "cavatica/cca-rb-pa-01",
      "name": "CCA_RB_PA_01"
    }
  ],
  "links": []
}
👍

To also access the dataset description field, use the fields=_all query parameter.