Skip to main content
Update an analysis's metadata

Path Parameters

analysis_id
string
required

Body

application/json

Partial update for an analysis. Does not replace the parquet.

name
string | null

New analysis name.

analysis_type
string | null

New analysis type (non-empty).

Minimum string length: 1
columns
AnalysisColumnSpec · object[] | null

Revised column specs.

metadata
Metadata · object | null

Replacement metadata dict.

notes
string | null

New free-text description of how the analysis was performed.

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

An analysis record as returned by the API.

measurement_id
string
required

ID of the parent cell measurement this analysis is derived from.

name
string
required

User-provided analysis name.

analysis_type
string
required

Kind of analysis, e.g. 'ecm_from_eis'. Free-form; see KNOWN_ANALYSIS_TYPES for the advisory set the frontend offers.

Minimum string length: 1
id
string
required

Unique identifier.

organization_id
string
required

Organization that owns this analysis.

project_id
string
required

Project this analysis belongs to, denormalized from the parent measurement.

created_at
string<date-time>
required

Creation timestamp.

updated_at
string<date-time>
required

Last update timestamp.

columns
AnalysisColumnSpec · object[]

Columns present in the analysis parquet, for header preview.

metadata
Metadata · object

Loose metadata: source RPT/cycle identity, extractor parameters, etc.

notes
string | null

Free-text human description of how the analysis was performed.

source_pipeline_id
string | null

FK to the pipeline this analysis was computed from.

source_simple_pipeline_id
string | null

FK to the simple pipeline this analysis was computed from.

source_analysis_id
string | null

FK to another analysis this analysis was computed from.

source_label
string | null

Free-text provenance note.

created_by
string | null

User ID of the creator.