Skip to main content
Update a material property dataset's metadata or column specs

Path Parameters

property_id
string
required

Body

application/json

Partial update for a material property dataset.

If columns is provided, the stored parquet is rebuilt from the preserved original file using the new column specs.

name
string | null

New dataset name

columns
ColumnSpec · object[] | null

Revised column specs. Must cover exactly the columns in the original uploaded file (minus any unnamed index columns).

source_pipeline_id
string | null

New source pipeline FK (null to clear).

source_simple_pipeline_id
string | null

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

source_analysis_id
string | null

New source analysis FK (null to clear).

source_label
string | null

New provenance note.

Response

Successful Response

Material property dataset record as returned by the API.

material_id
string
required

ID of the parent material

project_id
string
required

ID of the project this property is scoped to

name
string
required

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

columns
ColumnSpec · object[]
required

All columns in the dataset with their units.

id
string
required

Unique identifier

organization_id
string
required

Organization that owns this record

storage_path
string
required

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

data_version
integer
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.

created_at
string<date-time>
required

Upload timestamp

updated_at
string<date-time>
required

Last update timestamp

original_path
string | null

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

nan_counts
Nan Counts · object | null

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_header
boolean
default:false

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

created_by
string | null

User ID of the uploader

source_pipeline_id
string | null

FK to the pipeline this dataset was computed from.

source_simple_pipeline_id
string | null

FK to the simple pipeline this dataset was computed from.

source_analysis_id
string | null

FK to the analysis this dataset was computed from.

source_label
string | null

Free-text provenance note.