Sign in
Analyses

Update an analysis's metadata

Update analysis metadata fields. Does not replace the parquet.

patch/analyses/{analysis_id}

Path parameters

analysis_idstring required

Request body

namestring nullable

New analysis name.

analysis_typestring nullable

New analysis type (non-empty).

metadataobject nullable

Replacement metadata dict.

notesstring nullable

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

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

measurement_idstring required

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

namestring required

User-provided analysis name.

analysis_typestring required

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

metadataobject

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

notesstring nullable

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

source_pipeline_idstring nullable

FK to the pipeline this analysis was computed from.

source_simple_pipeline_idstring nullable

FK to the simple pipeline this analysis was computed from.

source_analysis_idstring nullable

FK to another analysis this analysis was computed from.

source_labelstring nullable

Free-text provenance note.

idstring required

Unique identifier.

organization_idstring required

Organization that owns this analysis.

project_idstring required

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

created_bystring nullable

User ID of the creator.

created_atstring date-time required

Creation timestamp.

updated_atstring date-time required

Last update timestamp.

Changes