plnnrlydevelopers

Deze referentie is alleen in het Engels. Naar het Nederlandse REST API-overzicht

Diese Referenz gibt es nur auf Englisch. Zur deutschen REST-API-Übersicht

Cette référence existe uniquement en anglais. Aller à la présentation de l'API REST en français

Esta referencia solo está en inglés. Ir a la introducción de la API REST en español

Timer

Timer

A running stopwatch: one row per employee per timed record, created when the timer starts and deleted when it is discarded or its minutes are booked.

View as Markdown
Summary view
TimerList, 10 fields. What a list returns by default.
Detail view
Timer, 10 fields. The default for a single read and for every write.
Read with
api:read:hoursandhours::read
Write with
api:write:hours

There is at most one timer per employee-and-target pair. started_at is the only state a timer carries: elapsed time is derived from it by the client, which needs no server clock. A timer on a record type this API does not publish (an Outlook event, which the agenda really does time) renders timeable as the bare {"id": N} reference form, with timeable_type intact and no expansion available.

Used by

GETList running timers/timersTimerList
POSTStart a timer/timersTimer
GETRead a timer/timers/{timer}Timer
PATCHCorrect a timer/timers/{timer}Timer

Fields

Detail only
Only in the detail view.
Only with include
Only when you ask for it with include.
Server-assigned
Set by plnnrly, never by a request.
idinteger

Unique identifier.

user_idintegerServer-assigned

Employee this timer belongs to. Always the authenticated user; a timer cannot be started for someone else.

userRef or UserSummary

The employee this timer belongs to. Expanding it with ?include=user additionally requires the users::read permission and a token scope covering the users prefix.

timeable_typestring

The kind of record timeable points at; it says which branch of timeable applies.

work_itemevent

New values may be added.

timeable_idinteger

The id of the record timeable points at.

timeableRef or WorkItemSummary or EventSummary

The record being timed. Expanding it with ?include=timeable additionally requires the read permission and token scope of the target's own prefix, per branch: project_management for a work item, events for a planning event.

Which form you get depends on timeable_type.

work_item
WorkItemSummary
event
EventSummary
started_attimestamp (YYYY-MM-DDThh:mm:ssZ)

When the stopwatch was started. Elapsed time is this value against the client's own clock; the API publishes no elapsed counter.

created_attimestamp (YYYY-MM-DDThh:mm:ssZ)

Creation timestamp.

updated_attimestamp (YYYY-MM-DDThh:mm:ssZ)

Last-write timestamp; use for incremental sync.

Variants

TimerList 10 fields

What a collection returns, and what ?view=summary returns on a single record.

The same fields as the detail object.

TimerSummary 2 fields

The embedded form: what you get when another resource carries this one and you did not include it.

Leaves out: user_id, user, timeable_type, timeable_id, timeable, created_at, updated_at, links

TimerLinks 1 field

The links object on this resource.

Keys: self

Polymorphic fields

timeableWhich form you get depends on timeable_type.