publish¶

Publish computed traces as a new dataset.

Signature¶

publish(traces: list[object], name: str, description: str='', params: dict[str, object] | None=None, project: str | None=None) -> dict[str, object]

Name	Type	Required	Default
`traces`	`list[object]`	yes	-
`name`	`str`	yes	-
`description`	`str`	no	`''`
`params`	`dict[str, object] \\| None`	no	`None`
`project`	`str \\| None`	no	`None`

Schema: DatasetCreateSchema

Field	Type	Required
`description`	`string`	yes
`parameters`	`array<ParameterValueCreateSchema>`	no
`project_id`	`string`	yes
`source_type`	`string`	no
`title`	`string`	yes

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

Required permission: dataset:create

POST /api/datasets/ (createDataset)

cs.publish(traces, name)