timeTracking

Stops the currently running time tracking of the specified user.

Changed on

The request body is optional. You can provide a stopReason to indicate how the tracking was stopped. For external API clients, the stopReason is automatically set to "external-api" regardless of what is provided. For this operation to work there must be a running time tracking for the user.

<Check title="Required Permissions" icon="key">The user must be an admin or the creator.</Check>

post/users/{userId}/timetracking/stop

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/users/{userId}/timetracking/stop
  • Auth: HTTP bearer

Path parameters

userIdstring uuid required

The id of the user.

Request body

StopTimeTrackingForm required

Form for stopping a time tracking.

Response

OK

isBillableboolean

Whether the time tracking is billable or not.

isBilledboolean

Whether the time tracking is billed or not.

taskIdstring uuid nullable

The id of the task.

projectIdstring uuid nullable

The id of the project.

notestring nullable

The note of the time tracking.

startDateUtcstring date-time nullable

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

startTimeUtcstring nullable

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

endDateUtcstring date-time nullable

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

endTimeUtcstring nullable

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 date-time nullable

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

startTimeLocalstring nullable

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

endDateLocalstring date-time nullable

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

endTimeLocalstring nullable

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.

timezonestring required

The original timezone of the time tracking. The format of the timezone is the IANA standard.

durationinteger nullable

The duration of the time tracking in seconds. Required when the time tracking has already been completed and EndTime has not been set.

breakDurationinteger nullable

The duration of the break in seconds. Cannot be set via API.

typeOfWorkIdstring uuid required

The id of the type of work.

userIdstring uuid nullable

The id of the user. Can be null if the user was deleted.

idstring uuid

The id of the time tracking.

createdBystring uuid

The id of the user who created this time tracking.

createdOnstring date-time

The date this time tracking was created.

updatedBystring uuid

The id of the user who last updated this time tracking.

updatedOnstring date-time

The date this time tracking was last modified.

resourceVersioninteger

The version of the entity, updated on every modification, to the ticks in UTC. Not identical to UpdatedOn.

isExternalboolean

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

Changes

  • 1556e0487867Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e46cf415581Revision changes
    • info

      api operation id PostStopTimeTrackingByUserId removed and replaced with timeTracking_PostStopTimeTrackingByUserId