Sign in
TimeTracking

Stops the currently running time tracking of the specified user.

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

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.

isDateOnlyboolean

Whether the time entry is a date only entry.

startDatestring date-time

The date and time when the time entry was started in UTC. Required.

endDatestring date-time nullable

The date and time when the time entry ends in UTC. Not set if the time entry is still running.

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 entry is not running.

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.

breakDurationinteger nullable

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

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).

Example response

{
  "isBillable": true,
  "taskId": "123e4567-e89b-12d3-a456-426614174000",
  "projectId": "123e4567-e89b-12d3-a456-426614174000",
  "note": "I created a first draft for the new sitemap",
  "timezone": "Europe/Berlin",
  "duration": 8635,
  "typeOfWorkId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "typeOfWork": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Design",
    "icon": "thumb_up"
  },
  "user": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "firstName": "Carla",
    "lastName": "Creative"
  },
  "task": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Design",
    "baseType": "projecttask",
    "taskStatusId": "123e4567-e89b-12d3-a456-426614174000",
    "typeOfWorkId": "123e4567-e89b-12d3-a456-426614174000",
    "project": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Design",
      "projectStatus": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Design",
        "description": "Work in progress",
        "type": "todo"
      },
      "company": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Design",
        "hasImage": true,
        "description": "One of our customers"
      },
      "projectType": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Design",
        "icon": "thumb_up"
      },
      "hasImage": true,
      "createdBy": "123e4567-e89b-12d3-a456-426614174000"
    },
    "projectId": "123e4567-e89b-12d3-a456-426614174000",
    "plannedDuration": 21600,
    "taskStatus": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Design",
      "description": "Work in progress",
      "type": "todo",
      "order": 1,
      "icon": "arrow_forward"
    },
    "createdBy": "123e4567-e89b-12d3-a456-426614174000",
    "correlationId": "123e4567-e89b-12d3-a456-426614174000",
    "parentId": "123e4567-e89b-12d3-a456-426614174000",
    "parentTask": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Design"
    }
  },
  "project": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Design",
    "projectStatus": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Design",
      "description": "Work in progress",
      "type": "todo"
    },
    "company": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Design",
      "hasImage": true,
      "description": "One of our customers"
    },
    "projectType": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Design",
      "icon": "thumb_up"
    },
    "hasImage": true,
    "createdBy": "123e4567-e89b-12d3-a456-426614174000"
  },
  "breaks": [
    {
      "startDate": "2022-01-01T12:00:00Z",
      "duration": 3600,
      "endDate": "2022-01-01T13:00:00Z"
    }
  ],
  "resourceVersion": 637825154598057900,
  "isExternal": true
}

Changes

Changed in 7 of the 20 revisions of this API.21610

  • v2e2278b9be9e31See the full diff
    • ▲

      removed the media type application/json for the response with the status

      response-media-type-removed

  • v2573939b95e0616See the full diff
    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

  • v24ef0173acbbe1See the full diff
    • ○

      added optional request body

      request-body-added-optional

  • v22efdeb36681c1See the full diff
    • ○

      api operation id PostStopTimeTrackingByUserIdV2 was added

      api-operation-id-added

  • v2ee9766594c446See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

  • v2b4107303220b1See the full diff
    • ○

      added the success response with the status

      response-success-status-added

  • v247bb6359513711See the full diff
    • ▲

      removed the success response with the status

      response-success-status-removed

    • ○

      added the success response with the status

      response-success-status-added