Skip to main content
PUT
/
api
/
dataframer
/
datasets
/
{dataset_id}
JavaScript
import Dataframer from 'dataframer';

const client = new Dataframer({
  apiKey: 'My API Key',
});

const dataset = await client.dataframer.datasets.update('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(dataset.id);
{
  "name": "<string>",
  "dataset_type": "SINGLE_FILE",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "dataset_type_display": "<string>",
  "config_json": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "created_by": 123,
  "created_by_name": "<string>",
  "company": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "company_name": "<string>",
  "folders": [
    {
      "name": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "description": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "files": [
        {
          "file_name": "<string>",
          "file_type": "JSON",
          "storage_uri": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "file_type_display": "<string>",
          "bytes_size": 0,
          "sha256": "<string>",
          "folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "datasets_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "created_at": "2023-11-07T05:31:56Z"
        }
      ],
      "file_count": 123
    }
  ],
  "folder_count": 123,
  "file_count": 123,
  "short_sample_compatibility": {
    "is_short_samples_compatible": true,
    "is_long_samples_compatible": true,
    "reason": "<string>"
  }
}

Authorizations

Authorization
string
header
required

API Key authentication. Format: "Bearer YOUR_API_KEY"

Path Parameters

dataset_id
string
required

Body

application/json
name
string

New dataset name

description
string

New dataset description

Response

Dataset updated successfully

name
string
required
Minimum string length: 1
dataset_type
enum<string>
required
Available options:
SINGLE_FILE,
MULTI_FILE,
MULTI_FOLDER
id
string<uuid>
description
string | null
dataset_type_display
string
Minimum string length: 1
config_json
Config json · object
created_at
string<date-time>
updated_at
string<date-time>
created_by
integer
created_by_name
string
Minimum string length: 1
company
string<uuid>
company_name
string
Minimum string length: 1
folders
object[]
folder_count
integer
file_count
integer
short_sample_compatibility
Short sample compatibility · object