Planned Measurements

Create a planned measurement

Create a requested or scheduled planned measurement.

post/projects/{project_id}/planned_measurements

Path parameters

project_idstring required

Request body

namestring required

cell_specification_idstring nullable

Cell specification the requester wants tested (set at request time).

cell_instance_idstring nullable

Cell instance this future measurement will run on.

channel_idstring nullable

Channel reserved for this measurement, once scheduled.

set_temperature_cnumber nullable

Temperature this test must run at, in degrees Celsius, held fixed for the whole test. None means ambient: the test runs outside a thermal chamber.

thermal_chamber_idstring nullable

Chamber this test's channel sits in for the reservation. Recorded per reservation rather than per channel, because channels move between chambers.

protocol_idstring nullable

Named protocol (experiment_template) this measurement will run. Required on create; a planned measurement must name a protocol.

program_idstring nullable

Optional catalog program (Formation, Cycling, …) for this test request.

test_setupobject nullable

Planned physical setup.

planned_start_timestring date-time nullable

When setup/run is planned to start.

planned_end_timestring date-time nullable

When this planned measurement is expected to release the channel.

estimated_duration_secondsinteger nullable

Expected run duration before scheduled times exist.

setup_duration_secondsinteger

Operator setup duration before the test starts.

teardown_duration_secondsinteger

Operator teardown duration after the test finishes.

notesstring nullable

Free-text planning notes.

status'requested' | 'scheduled' | 'in_progress' | 'completed' | 'cancelled'

Lifecycle state for a planned measurement.

Response

Successful Response

namestring required

cell_specification_idstring nullable

Cell specification the requester wants tested (set at request time).

cell_instance_idstring nullable

Cell instance this future measurement will run on.

channel_idstring nullable

Channel reserved for this measurement, once scheduled.

set_temperature_cnumber nullable

Temperature this test must run at, in degrees Celsius, held fixed for the whole test. None means ambient: the test runs outside a thermal chamber.

thermal_chamber_idstring nullable

Chamber this test's channel sits in for the reservation. Recorded per reservation rather than per channel, because channels move between chambers.

protocol_idstring nullable

Named protocol (experiment_template) this measurement will run. Required on create; a planned measurement must name a protocol.

program_idstring nullable

Optional catalog program (Formation, Cycling, …) for this test request.

test_setupobject nullable

Planned physical setup.

planned_start_timestring date-time nullable

When setup/run is planned to start.

planned_end_timestring date-time nullable

When this planned measurement is expected to release the channel.

estimated_duration_secondsinteger nullable

Expected run duration before scheduled times exist.

setup_duration_secondsinteger

Operator setup duration before the test starts.

teardown_duration_secondsinteger

Operator teardown duration after the test finishes.

notesstring nullable

Free-text planning notes.

idstring required

organization_idstring required

project_idstring required

status'requested' | 'scheduled' | 'in_progress' | 'completed' | 'cancelled' required

Lifecycle state for a planned measurement.

requested_bystring required

scheduled_bystring nullable

scheduled_atstring date-time nullable

started_measurement_idstring nullable

cancelled_atstring date-time nullable

completed_atstring date-time nullable

created_atstring date-time required

updated_atstring date-time required

requested_by_emailstring nullable

scheduled_by_emailstring nullable

channel_namestring nullable

cycler_idstring nullable

cycler_namestring nullable

program_namestring nullable

estimated_duration_status'estimating' | 'ready' | 'failed'

Lifecycle of a duration estimate computed by a background simulation.

Used by both estimates: a planned test's total duration (planned_measurements.estimated_duration_*) and a running test's remaining duration (cell_measurements.estimated_end_time_*). One enum because the lifecycle is identical -- only what is being estimated differs.

estimating while the job is in flight, ready once a value came from it, failed with the reason in the accompanying note. None means no estimate was ever requested.

estimated_duration_job_idstring nullable

estimated_duration_simulation_idstring nullable

simulated_duration_secondsinteger nullable

estimated_duration_is_exactboolean nullable

estimated_duration_margin_pctnumber nullable

actual_duration_secondsinteger nullable

estimated_duration_notestring nullable

estimated_duration_calculated_atstring date-time nullable

Changes

No recorded changes to this endpoint across all 1 revision of this API.