IOionworks
Planned Measurements

List planned measurements for a project

Changed on

List a project's planned measurements.

name supports Supabase filter operators (e.g. ilike.%formation% for a partial match, eq.Formation for an exact match).

channel_id and protocol_id are exact match.

started_measurement_id finds the request a real measurement came from, which is what a measurement page needs to link back to its request.

q is the search box's free-text query, which also matches the related names the table shows; it composes with the column filters above.

get/projects/{project_id}/planned_measurements

Request

  • Base URL
    https://api.ionworks.com
  • URL
    https://api.ionworks.com/projects/{project_id}/planned_measurements
  • Auth
    none declared

Path parameters

project_idstring uuid required

Query parameters

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

Lifecycle state for a planned measurement.

channel_idstring uuid nullable
protocol_idstring uuid nullable
namestring nullable
started_measurement_idstring uuid nullable
qstring nullable

Free-text search on the plan name plus prefix full-text match on the protocol, cell spec, program, cycler and channel names the scheduler table displays, matching the global search.

limitinteger
offsetinteger
order_by'planned_start_time' | 'planned_end_time' | 'created_at' | 'updated_at' | 'name' | 'status'
order'asc' | 'desc'

Response

Successful Response

unknown required

Changes

  • af9fdad1dc5bRevision changes
    • info

      added the new optional query request parameter started_measurement_id

  • ea3d377fec1aRevision changes
    • breaking

      for the query request parameter channel_id, the format of property anyOf[subschema #1]/ was specialized from no format to uuid

    • breaking

      for the query request parameter protocol_id, the format of property anyOf[subschema #1]/ was specialized from no format to uuid

    • breaking

      for the path request parameter project_id, the format changed from no format to uuid