API v1 ReferenceTime Entries

Updates the time entry with the specified id.

Updates the time entry with the specified id. Depending on the time entry, the calling users has to have several permissions to update the time entry: No permissions are required if the calling user is owner of this time entry. If the calling user is not the creator of the time entry and the time entry is connected to a project, ‘write’ permissions on the ‘project-timetracking’ feature are necessary. If the time entry is connected to a task, the user needs to be assignee of this task or the user needs permissions on: ‘project-planning-data’ if it is a project task. The break duration of the time entry is kept the same. The break duration cannot be smaller than the duration of the time entry. To remove the breaks, use the endpoint POST /timeentries/{id}/removeBreaks. Following combination of times and duration are allowed for already completed time entries:

  • start time (local or utc) and end time (local or utc) (this option always takes precedence)
  • start time (local or utc) and duration
  • end time (local or utc) and duration For running time entries, you can only update the start time (local or utc) while the duration stays 0.
Required Permissions
Any authenticated user.

Path parameters

timeEntryIdUUIDRequired
The id of the time entry.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
timezonestringRequired>=1 character
The original timezone of the time tracking. The format of the timezone is the IANA standard.
typeOfWorkIdUUIDRequired
The id of the type of work.
isBillablebooleanOptional
Whether the time tracking is billable or not.
isBilledbooleanOptional
Whether the time tracking is billed or not.
taskIdUUID or nullOptional
The id of the task.
projectIdUUID or nullOptional
The id of the project.
notestring or nullOptional
The note of the time tracking.
startDateUtcdatetime or nullOptional

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

startTimeUtcstring or nullOptional

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

endDateUtcdatetime or nullOptional

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

endTimeUtcstring or nullOptional

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.

startDateLocaldatetime or nullOptional

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

startTimeLocalstring or nullOptional

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

endDateLocaldatetime or nullOptional

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

endTimeLocalstring or nullOptional

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 nullOptional
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 nullOptional
The duration of the break in seconds. Cannot be set via API.
userIdUUID or nullOptional
The id of the user. Can be null if the user was deleted.

Response

OK
timezonestring>=1 character
The original timezone of the time tracking. The format of the timezone is the IANA standard.
typeOfWorkIdUUID
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.
taskIdUUID or null
The id of the task.
projectIdUUID or null
The id of the project.
notestring or null
The note of the time tracking.
startDateUtcdatetime or null

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

startTimeUtcstring or null

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

endDateUtcdatetime or null

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.

startDateLocaldatetime or null

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

startTimeLocalstring or null

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

endDateLocaldatetime or null

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.
userIdUUID or null
The id of the user. Can be null if the user was deleted.
idUUID or null
The id of the time tracking.
createdByUUID or null
The id of the user who created this time tracking.
createdOndatetime or null
The date this time tracking was created.
updatedByUUID or null
The id of the user who last updated this time tracking.
updatedOndatetime or null
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).