Sign in
Material Property Datasets

Update a material property dataset's metadata or column specs

Update dataset name and/or column specs.

When columns is provided, the original uploaded file is re-parsed and the processed parquet is rebuilt with the new column metadata. Column names must exactly match those in the original file.

patch/material_property_datasets/{property_id}

Path parameters

property_idstring required

Request body

namestring nullable

New dataset name

source_pipeline_idstring nullable

New source pipeline FK (null to clear).

source_simple_pipeline_idstring nullable

New source simple-pipeline FK (null to clear).

source_analysis_idstring nullable

New source analysis FK (null to clear).

source_labelstring nullable

New provenance note.

Response

Successful Response

material_idstring required

ID of the parent material

project_idstring required

ID of the project this property is scoped to

namestring required

User-provided dataset name, e.g. 'Electrolyte transport'

idstring required

Unique identifier

organization_idstring required

Organization that owns this record

storage_pathstring required

Path to the processed parquet file in the material-property-datasets bucket.

original_pathstring nullable

Path to the raw original file in the material-property-datasets bucket. NULL only for records created before this field was introduced.

data_versioninteger required

Increments on every data-changing operation (file replacement or column re-processing). Downstream code can store this alongside computed results and compare against the current value to detect staleness.

nan_countsobject nullable

Number of NaN/null values per column, keyed by display name. Computed at upload time. None for records uploaded before this field was introduced.

no_headerboolean

True when the uploaded CSV had no header row. Column positions are mapped via source_column_index on each column spec.

created_bystring nullable

User ID of the uploader

created_atstring date-time required

Upload timestamp

updated_atstring date-time required

Last update timestamp

source_pipeline_idstring nullable

FK to the pipeline this dataset was computed from.

source_simple_pipeline_idstring nullable

FK to the simple pipeline this dataset was computed from.

source_analysis_idstring nullable

FK to the analysis this dataset was computed from.

source_labelstring nullable

Free-text provenance note.

Changes