Skip to main content
Update a planned measurement

Path Parameters

project_id
string
required
planned_measurement_id
string
required

Body

application/json

Request model for patching a planned measurement.

name
string | null
Required string length: 1 - 255
status
enum<string> | null

Lifecycle state for a planned measurement.

Available options:
requested,
scheduled,
in_progress,
completed,
cancelled
cell_specification_id
string | null
cell_instance_id
string | null
channel_id
string | null
protocol
Protocol · object | null
test_setup
Test Setup · object | null
planned_start_time
string<date-time> | null
planned_end_time
string<date-time> | null
estimated_duration_seconds
integer | null
Required range: x >= 1
setup_duration_seconds
integer | null
Required range: x >= 0
teardown_duration_seconds
integer | null
Required range: x >= 0
started_measurement_id
string | null
notes
string | null

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
Protocol · object | null

Planned protocol metadata.

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
created_by_email
string | null