Dataset.set_preferred_figure¶

Select an attached valid figure as this dataset's view (dataset:update).

Signature¶

set_preferred_figure(figure_id: str) -> Dataset

Name	Type	Required	Default
`figure_id`	`str`	yes	-

Name	In	Type	Required	Default
`dataset_id`	`path`	`string`	yes	-

Schema: PreferredFigureIn

Field	Type	Required
`figure_id`	`string`	yes

HTTP 200 — OK

Schema: DatasetSchema

Field	Type	Required
`context_completeness`	`ContextCompletenessSchema`	no
`created_at`	`string`	no
`datafiles`	`array<DataFileSummarySchema>`	no
`description`	`string`	yes
`id`	`string`	yes
`imagefile`	`ImageFileSchema`	no
`instruments`	`array<InstrumentSourceSchema>`	no
`metadata_assessment`	`MetadataAssessmentOut`	no
`owner`	`DatasetOwnerSchema`	no
`param_snaps`	`array<ParamSnapSchema>`	no
`parameters`	`array<ParameterValueSchema>`	no
`preferred_figure_id`	`string`	no
`project_id`	`string`	yes
`related_files`	`array<RelatedFileSchema>`	no
`report_count`	`integer`	no
`setup_artifacts`	`array<SetupArtifactOut>`	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

Required permission: dataset:update

PUT /api/datasets/{id}/preferred-figure (setDatasetPreferredFigure)

dataset.set_preferred_figure(figure_id)