API v1 ReferenceTime Tracking

Starts a new time tracking for a user.

If there is already a running/paused time tracking it will be stopped automatically in order to start the new one. <Check title="Required Permissions">The user must be an admin or the creator.</Check>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

userIdstringRequiredformat: "uuid"
The id of the user. Not required if the me route is used.

Request

The model to start a time tracking.
typeOfWorkIdstringRequiredformat: "uuid"
The id of the type of work of the time tracking.
timezonestringRequired>=1 character
The original timezone of the time tracking. The format of the timezone is the IANA standard.
isBillablebooleanOptional
Whether the time tracking is billable or not.
isBilledbooleanOptional
Whether the time tracking is billed or not.
taskIdstring or nullOptionalformat: "uuid"
The id of the task.
projectIdstring or nullOptionalformat: "uuid"
The id of the project.
notestring or nullOptional
The note of the time tracking.

Response

OK
timezonestring>=1 character
The original timezone of the time tracking. The format of the timezone is the IANA standard.
typeOfWorkIdstringformat: "uuid"
The id of the type of work.
isBillableboolean or null
Whether the time tracking is billable or not.
isBilledboolean or null
Whether the time tracking is billed or not.
taskIdstring or nullformat: "uuid"
The id of the task.
projectIdstring or nullformat: "uuid"
The id of the project.
notestring or null
The note of the time tracking.
startDateUtcstring or nullformat: "date-time"

The date (in UTC) when the time tracking was started.

startTimeUtcstring or null

The time (in UTC) when the time tracking was started.

endDateUtcstring or nullformat: "date-time"

The date (in UTC) when the time tracking was stopped.

endTimeUtcstring or null

The time (in UTC) when the time tracking was stopped. Required when the time tracking has already been completed and Duration has not been set.

startDateLocalstring or nullformat: "date-time"

The date (in Local) when the time tracking was started.

startTimeLocalstring or null

The time (in Local) when the time tracking was started.

endDateLocalstring or nullformat: "date-time"

The date (in Local) when the time tracking was stopped.

endTimeLocalstring or null

The time (in Local) when the time tracking was stopped. Required when the time tracking has already been completed and Duration has not been set.

durationinteger or null
The duration of the time tracking in seconds. Required when the time tracking has already been completed and EndTime has not been set.
breakDurationinteger or null
The duration of the break in seconds. Cannot be set via API.
userIdstring or nullformat: "uuid"
The id of the user. Can be null if the user was deleted.
idstring or nullformat: "uuid"
The id of the time tracking.
createdBystring or nullformat: "uuid"
The id of the user who created this time tracking.
createdOnstring or nullformat: "date-time"
The date this time tracking was created.
updatedBystring or nullformat: "uuid"
The id of the user who last updated this time tracking.
updatedOnstring or nullformat: "date-time"
The date this time tracking was last modified.
typeOfWorkobject or null
userobject or null
taskobject or null
projectobject or null
breakslist of objects or null
The breaks of the time tracking.
resourceVersionlong or null
The version of the entity, updated on every modification, to the ticks in UTC. Not identical to UpdatedOn.
isExternalboolean or null

True if this entity is coming from an external workspace (awork Connect).