get https://cavatica-api.sbgenomics.com/v2
/datasets/{owner}/{dataset}
Heads Up!
This page documents the Advanced Access version (think "beta" but with fewer bugs) of the Datasets API functionality.
This call lists retrieves details of the specified dataset.
https://cavatica-api.sbgenomics.com/v2/datasets/{owner}/{dataset}
Request
Example request
GET /v2/datasets/rfranklin/pnoc-dipg-pa-02
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: c2e05946fb9a494ab5c19c72a94cb4ac" -H "x-sbg-advance-access: advance" -H "Content-Type: application/json" "http://cavatica-api.sbgenomics.com/v2/datasets/rfranklin/pnoc-dipg-pa-02"
Header fields
| Name | Description |
|---|---|
X-SBG-Auth-Tokenrequired | Your CAVATICA authentication token. |
X-SBG-Advance-Accessrequired | advance |
Path parameters
| Name | Description |
|---|---|
owner | The owner whose datasets you want to query. |
dataset | The name of the dataset you are querying. |
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/pnoc-dipg-pa-02",
"id": "rfranklin/pnoc-dipg-pa-02",
"name": "PNOC_DIPG_PA_02",
"description": "This is a dataset description."
}