Dataset.update¶
Update dataset fields.
Signature¶
update(**kwargs: Any) -> None
Parameters¶
| Name | Type | Required | Default |
|---|---|---|---|
**kwargs |
Any |
no | - |
HTTP parameters¶
| Name | In | Type | Required | Default |
|---|---|---|---|---|
dataset_id |
path |
string |
yes | - |
Fields¶
Schema: DatasetUpdateSchema
| Field | Type | Required |
|---|---|---|
description |
string |
yes |
title |
string |
yes |
Return shape¶
HTTP 200 — OK
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:update
HTTP¶
PATCH /api/datasets/{id} (updateDataset)
Usage¶
ds.update(title="Sweep 25C — Final", description="Corrected data")