Skip to main content
Estimate a planned measurement's duration from its protocol

Path Parameters

project_id
string
required
planned_measurement_id
string
required

Body

application/json

Options for a planned test's duration estimate.

The body is optional on the endpoint; omitting it takes the default margin.

buffer_pct
number | null
Required range: 0 <= x <= 100

Response

Successful Response

A planned measurement row returned by the API.

name
string
required
Required string length: 1 - 255
id
string
required
organization_id
string
required
project_id
string
required
status
enum<string>
required

Lifecycle state for a planned measurement.

Available options:
requested,
scheduled,
in_progress,
completed,
cancelled
requested_by
string
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
cell_specification_id
string | null

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

cell_instance_id
string | null

Cell instance this future measurement will run on.

channel_id
string | null

Channel reserved for this measurement, once scheduled.

protocol_id
string | null

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

program_id
string | null

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

test_setup
Test Setup · object | null

Planned physical setup.

planned_start_time
string<date-time> | null

When setup/run is planned to start.

planned_end_time
string<date-time> | null

When this planned measurement is expected to release the channel.

estimated_duration_seconds
integer | null

Expected run duration before scheduled times exist.

Required range: x >= 1
setup_duration_seconds
integer
default:0

Operator setup duration before the test starts.

Required range: x >= 0
teardown_duration_seconds
integer
default:0

Operator teardown duration after the test finishes.

Required range: x >= 0
notes
string | null

Free-text planning notes.

scheduled_by
string | null
scheduled_at
string<date-time> | null
started_measurement_id
string | null
cancelled_at
string<date-time> | null
completed_at
string<date-time> | null
requested_by_email
string | null
scheduled_by_email
string | null
channel_name
string | null
cycler_id
string | null
cycler_name
string | null
program_name
string | null
estimated_duration_status
enum<string> | null

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.

Available options:
estimating,
ready,
failed
estimated_duration_job_id
string | null
estimated_duration_simulation_id
string | null
simulated_duration_seconds
integer | null
estimated_duration_is_exact
boolean | null
estimated_duration_margin_pct
number | null
actual_duration_seconds
integer | null
estimated_duration_note
string | null
estimated_duration_calculated_at
string<date-time> | null