Seven Bridges knowledge centerDocumentation
API Reference

List members of a dataset

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

/datasets/{owner}/{dataset}/members

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 returns all members of the specified dataset.

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

Request

Example request

GET /v2/datasets/rfranklin/pnoc-dipg-pa-02/members"
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/pnoc-dipg-pa-02/members"

Header fields

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

Path parameters

NameData type
'owner'The owner of the dataset you are querying.
datasetThe 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/pcgc-chd-pa-01/members?offset=0&limit=5",
  "items": [
    {
      "href": "http://cavatica-api.sbgenomics.com/v2/datasets/rfranklin/pcgc-chd-pa-01/members/rfranklin",
      "username": "rfranklin",
      "permissions": {
        "write": true,
        "read": true,
        "copy": true,
        "execute": true,
        "admin": true
      }
    },
    
    {
      "href": "http://cavatica-api.sbgenomics.com/v2/datasets/rfranklin/pcgc-chd-pa-01/members/jane_Smith",
      "username": "jane_smith",
      "permissions": {
        "write": true,
        "read": true,
        "copy": true,
        "execute": true,
        "admin": false
      }
    },
    {
      "href": "http://cavatica-api.sbgenomics.com/v2/datasets/rfranklin/pcgc-chd-pa-01/members/ted_smith",
      "username": "ted_smith",
      "permissions": {
        "write": true,
        "read": true,
        "copy": true,
        "execute": true,
        "admin": false
      }
    },
    {
      "href": "http://cavatica-api.sbgenomics.com/v2/datasets/rfranklin/pcgc-chd-pa-01/members/sarah_smith",
      "username": "sarah_smith",
      "permissions": {
        "write": true,
        "read": true,
        "copy": true,
        "execute": true,
        "admin": true
      }
    }
  ],
  "links": []
}
Language