> ## Documentation Index > Fetch the complete documentation index at: https://docs.ionworks.com/llms.txt > Use this file to discover all available pages before exploring further. # Estimate a running measurement's end time from its remaining protocol > Forecast when this still-running test will finish. Replays the measured steps onto the protocol's state machine, then simulates only the remainder with the cell specification's default model. Returns immediately, marked ``estimating``; ``estimated_end_time`` lands when the simulation finishes. ## OpenAPI ````yaml https://api.ionworks.com/openapi.json patch /cell_measurements/{measurement_id}/estimate_end_time openapi: 3.1.0 info: title: FastAPI version: 0.1.0 servers: - url: https://api.ionworks.com description: Production security: [] paths: /cell_measurements/{measurement_id}/estimate_end_time: patch: tags: - Cell Measurements summary: Estimate a running measurement's end time from its remaining protocol description: >- Forecast when this still-running test will finish. Replays the measured steps onto the protocol's state machine, then simulates only the remainder with the cell specification's default model. Returns immediately, marked ``estimating``; ``estimated_end_time`` lands when the simulation finishes. operationId: >- estimate_cell_measurement_end_time_cell_measurements__measurement_id__estimate_end_time_patch parameters: - name: measurement_id in: path required: true schema: type: string title: Measurement Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CellMeasurement' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' components: schemas: CellMeasurement: properties: name: type: string maxLength: 255 minLength: 1 title: Name protocol: anyOf: - additionalProperties: true type: object - type: 'null' title: Protocol description: >- Protocol information. Typical keys: 'name' (str), 'ambient_temperature_degc' (float), 'definition' (dict | str — a UCP protocol definition or another protocol format). start_time: anyOf: - type: string format: date-time - type: 'null' title: Start Time description: >- ISO 8601 datetime with timezone (UTC preferred) marking when the test started. end_time: anyOf: - type: string format: date-time - type: 'null' title: End Time description: >- ISO 8601 datetime with timezone (UTC preferred) marking when the test finished. Leave null while the test is still running; set it once the measurement is complete. A null end_time means the cell is still considered 'on test' in the Lab view. estimated_end_time: anyOf: - type: string format: date-time - type: 'null' title: Estimated End Time description: >- ISO 8601 datetime with timezone (UTC preferred) forecasting when a still-running test will finish. Distinct from end_time (the actual finish): this is an estimate. Null when no estimate has been computed yet. estimated_end_time_note: anyOf: - type: string - type: 'null' title: Estimated End Time Note description: Free-text explanation of how estimated_end_time was derived. estimated_end_time_calculated_at: anyOf: - type: string format: date-time - type: 'null' title: Estimated End Time Calculated At description: >- ISO 8601 datetime with timezone marking when estimated_end_time was last computed. test_setup: anyOf: - additionalProperties: true type: object - type: 'null' title: Test Setup description: >- Physical test setup. Typical keys: 'cycler' (model), 'operator', 'lab', 'channel_number' (int). step_labels_validated: type: boolean title: Step Labels Validated description: >- Set to true only once step-type labels (Rest, CC charge, CV, discharge, etc.) have been manually reviewed. Server-inferred labels should leave this false. default: false notes: anyOf: - type: string - type: 'null' title: Notes description: Free-text notes about the cell measurement measurement_type: $ref: '#/components/schemas/MeasurementType' description: >- What shape of data this measurement holds. Determines which fields are populated and which upload flow applies. See the class docstring. default: time_series properties: anyOf: - additionalProperties: true type: object - type: 'null' title: Properties description: >- Flat key/value measurements, populated only when measurement_type is 'properties'. Numeric values use the Quantity format. Example: {'thickness': {'value': 0.52, 'unit': 'mm'}, 'DCIR': {'value': 12, 'unit': 'mohm'}}. file_metadata: anyOf: - additionalProperties: true type: object - type: 'null' title: File Metadata description: Metadata about uploaded files (MIME types, dimensions, etc.) channel_id: anyOf: - type: string - type: 'null' title: Channel Id description: Optional ID of the channel this measurement ran on. program_id: anyOf: - type: string - type: 'null' title: Program Id description: >- Optional catalog program for this measurement (copied from a linked planned measurement when present). id: type: string title: Id cell_instance_id: type: string title: Cell Instance Id organization_id: type: string title: Organization Id description: Organization this measurement belongs to. project_id: type: string title: Project Id description: Project this measurement belongs to created_by: anyOf: - type: string - type: 'null' title: Created By description: User ID of the user who created this measurement created_by_email: anyOf: - type: string - type: 'null' title: Created By Email description: Email of the user who created this measurement processing_status: $ref: '#/components/schemas/MeasurementProcessingStatus' description: >- Lifecycle of server-side step processing. 'ready' once steps are available; 'pending'/'running' while the upload is being processed asynchronously; 'failed' if processing failed (see processing_error). default: ready processing_error: anyOf: - type: string - type: 'null' title: Processing Error description: Reason step processing failed, when processing_status is 'failed'. estimated_end_time_status: anyOf: - $ref: '#/components/schemas/EstimationStatus' - type: 'null' estimated_end_time_job_id: anyOf: - type: string - type: 'null' title: Estimated End Time Job Id created_at: type: string format: date-time title: Created At updated_at: type: string format: date-time title: Updated At type: object required: - name - id - cell_instance_id - organization_id - project_id - created_at - updated_at title: CellMeasurement HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError MeasurementType: type: string enum: - time_series - file - properties title: MeasurementType description: |- Shape of the data stored in a cell measurement. - ``time_series`` — cycling / diagnostic data uploaded as columnar time series (and optional step summaries). Default for new measurements. - ``file`` — an opaque file upload (raw cycler export, image, other binary). Metadata about the file is captured in ``file_metadata``; the file content lives in object storage. - ``properties`` — a flat key/value set of measured properties (thickness, mass, DCIR, initial capacity, …) with no time-series data. Numeric values use the Quantity format. MeasurementProcessingStatus: type: string enum: - pending - running - ready - failed title: MeasurementProcessingStatus description: >- Lifecycle of a measurement's server-side step processing. Step processing runs asynchronously on the task queue after upload: - ``pending`` — the confirm-upload task is enqueued but not yet picked up. - ``running`` — a worker is parsing/validating the upload or auto-calculating steps. - ``ready`` — steps are processed and available. The terminal success state, and the default for ``file``/``properties`` measurements (which never run step processing) and for rows created before async processing. - ``failed`` — processing failed permanently; ``processing_error`` holds the reason. EstimationStatus: type: string enum: - estimating - ready - failed title: EstimationStatus description: >- 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. ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError ````