Saltar al contenido principal
GET
List WrenchMode events (work logs)

Autorizaciones

X-API-KEY
string
header
requerido
OW-KEY
string
header
requerido

OpenWrench shared secret. Required on every request alongside X-API-KEY; issued together with your API key.

Parámetros de consulta

scheduleId
integer<int64>

Filter to one WrenchMode schedule. When present, pagination is DISABLED and the schedule's full event timeline is returned.

workOrderId
integer<int64>

Filter by work order id.

serviceCallId
integer<int64>

Filter by service call id.

locationId
integer<int64>

Filter by location id.

eventTypes
string

Comma-separated list of event types. Valid values: began_trip, trip_paused, trip_resumed, arrived, trip_cancelled, drive_note, started_work, ended_work, location_started, location_paused, location_resumed, location_ended. Unknown values are rejected with 400.

supplierEmails
string

Comma-separated list of technician emails, matched case-insensitively. (Only the plural key is exposed.)

fromDate
string

Window start, yyyy-MM-dd. Events from the start of this day are included, in the timezone zone or UTC when timezone is omitted. Malformed dates are rejected with 400.

toDate
string

Window end, yyyy-MM-dd. Events through the end of this day are included, in the timezone zone or UTC when timezone is omitted. Malformed dates are rejected with 400.

timezone
string

Optional IANA time zone name, such as America/Chicago or UTC, that fromDate and toDate are read in. fromDate starts at the beginning of that day in the zone, and toDate includes that whole day in the zone. The zone's real day boundaries apply, so a daylight saving change day is 23 or 25 hours long. When omitted, dates are UTC days. Names are case-sensitive. Fixed offsets (-05:00, GMT-5, Z, Etc/GMT+5), abbreviations (CST), and unknown names are rejected with 400.

Ejemplo:

"America/Chicago"

offset
integer

Number of records to skip.

Rango requerido: x >= 0
limit
integer

Page size. Default 10, maximum 25.

sort_by
string

Column name to sort by.

order
enum<string>

Sort direction.

Opciones disponibles:
asc,
desc

Respuesta

Successful response

type
string
requerido

Entity type label, e.g. "WrenchModeEvent". Endpoints that derive it via Scala reflection (most generic list/get endpoints) may return the fully qualified server class name instead (e.g. "models.workorder.WorkOrder"); treat this field as informational.

data
object[]
requerido
count
integer<int64>
requerido

Total number of matching records (across all pages)

status
enum<string>
requerido

"ok" on success

Opciones disponibles:
ok