Edit a dataset

/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 edits a dataset. You can use it to change the dataset name and description.

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

📘

If your client does not support PATCH requests, you can use POST to send this request, along with the query parameter _method=PATCH, e.g:

https://cavatica-api.sbgenomics.com/v2/datasets/{owner}/{dataset}?_method=PATCH

Request

Example request

PATCH /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 PATCH -H "X-SBG-Auth-Token: 5f2d7a4d8186488694fa3dc3844b7b06" -H "x-sbg-advance-access: advance" -H "Content-Type: application/json" -d '{
    "name": "New name for my dataset",
    "description" : "New description for my dataset"
}' "https://cavatica-api.sbgenomics.com/v2/datasets/rfranklin/pnoc-dipg-pa-02"

Request body

Key

Data type of value

Description of value

name

string

Enter the new name for your dataset.

description

string

Enter the new description for your dataset.

Example request body

{
    "name" : "New name for my dataset",
    "description" : "New description for my dataset"
}

Header fields

Name

Description

X-SBG-Auth-Token
required

Your CAVATICA authentication token.

X-SBG-Advance-Access
required

advance

Path parameters

Name

Description

owner

The owner of the dataset you are editing.

dataset

The name of the dataset you are editing.

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": "New name for my dataset",
  "description": "New description form my dataset"
}
Language
Click Try It! to start a request and see the response here!