Project.create_dataset¶
Create a dataset in this project.
Signature¶
create_dataset(title: str, **kwargs: Any) -> Dataset
Parameters¶
| Name | Type | Required | Default |
|---|---|---|---|
title |
str |
yes | - |
**kwargs |
Any |
no | - |
Fields¶
Schema: DatasetCreateSchema
| Field | Type | Required |
|---|---|---|
description |
string |
yes |
parameters |
array<ParameterValueCreateSchema> |
no |
project_id |
string |
yes |
source_type |
string |
no |
title |
string |
yes |
Return shape¶
HTTP 201 — Created
Schema: DatasetSchema
| Field | Type | Required |
|---|---|---|
created_at |
string |
no |
datafiles |
array<DataFileSummarySchema> |
no |
description |
string |
yes |
id |
string |
yes |
imagefile |
ImageFileSchema |
no |
instruments |
array<InstrumentSourceSchema> |
no |
owner |
DatasetOwnerSchema |
no |
param_snaps |
array<ParamSnapSchema> |
no |
parameters |
array<ParameterValueSchema> |
no |
project_id |
string |
yes |
related_files |
array<RelatedFileSchema> |
no |
slug |
string |
no |
slug_number |
integer |
no |
source_metadata |
object |
no |
source_type |
string |
no |
tags |
array<TagSchema> |
no |
title |
string |
yes |
updated_at |
string |
no |
Permission¶
Required permission: dataset:create
HTTP¶
POST /api/datasets/ (createDataset)
Usage¶
project.create_dataset(title)