Skip to main content
Record a cycler's open service as done

Path Parameters

cycler_id
string
required

Body

application/json

The body is of type Raw Data · object.

Response

Successful Response

One instrument-level service on a cycler.

A service event is the thing a channel incident belongs to when the whole cycler is down. Calibration is performed on the instrument, so a 40-channel cycler going in for its annual calibration is one event, not 40 unrelated outages that happen to share a category. Channel incidents opened for the event carry its id in service_event_id, which is what lets one action close them together.

At most one event per cycler may be open (performed_at null) — a unique partial index enforces it, so "the current service" is a single unambiguous row and the open-event write path is safe to retry.

id
string
required

Unique identifier for the service event

organization_id
string
required

Organization this service event belongs to.

project_id
string
required

Project that owns the cycler (pinned to it by FK)

cycler_id
string
required

The cycler being serviced

event_type
enum<string>
required

What kind of work this is

Available options:
calibration,
preventive_maintenance,
firmware,
repair,
other
created_at
string<date-time>
required

Timestamp when the event row was created

updated_at
string<date-time>
required

Timestamp when the event row was last updated

scheduled_for
string<date-time> | null

When the visit is booked. Required while the event is open; null is allowed on an event recorded after the fact.

performed_at
string<date-time> | null

When the service was actually done. Null means the event is still open — at most one such event per cycler.

notes
string | null

Free-text detail about the service

created_by
string | null

User who opened or recorded the event

performed_by
string | null

User who recorded the service as done