Seven Bridges knowledge centerDocumentation
API Reference

List datasets by owner

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

/datasets/{owner}

For general information on the API, including formatting, parameters, and pagination, please see the API Overview.

❗️

Heads Up!

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

This call lists datasets which belong to a specified owner.

https://cavatica-api.sbgenomics.com/v2/datasets/{owner}

Request

Example request

GET /v2/datasets/rfranklin
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/rfranklin"

Header fields

NameDescription
X-SBG-Auth-Token
required
Your CAVATICA authentication token.
X-SBG-Advance-Access
required		advance

Path parameters

NameDescription
ownerThe owner whose datasets you want to query.

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/rfranklin?offset=0&limit=3",
  "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"
    }
  ],
  "links": []
}

👍

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

Language