timeBookings

Updates a given time booking.

Changed on

Updates a given time booking. The saved booking reflects the submitted duration and assignment. <Check title="Required Permissions" icon="key">The user must have permission to access the requested resource.</Check>

put/projecttimebookings/{timeBookingId}

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/projecttimebookings/{timeBookingId}
  • Auth: HTTP bearer

Path parameters

timeBookingIdstring uuid required

The id of the time booking.

Request body

userIdstring uuid

The id of the user this time booking is for.

projectIdstring uuid nullable

(optional) The id of the project this time booking is for.

startDatestring date

The start date of this time booking.

endDatestring date

The end date and time of this time booking.

durationinteger

The duration (in seconds) of this time booking.

descriptionstring nullable

The optional name/description for this time booking.

laneOrderinteger

The order in which this object should be shown in the timeline (row number). This value is used by the awork web app.

Response

OK

idstring uuid

The id of the entity.

createdOnstring date-time

The date this entity was created.

createdBystring uuid

The id of the user who created this entity.

updatedOnstring date-time

The date this entity was last modified.

updatedBystring uuid

The id of the user who last modified this entity.

userIdstring uuid

The id of the user this time booking is for.

projectIdstring uuid nullable

(optional) The id of the project this time booking is for.

startDatestring date

The start date of the time booking.

endDatestring date

The end date of the time booking.

durationinteger

The planned duration, expressed in seconds, of this time booking.

descriptionstring nullable

The optional description for this time booking.

laneOrderinteger

The order in which this object should be shown in the timeline (row number). Used by the awork web app.

isAnonymizedboolean nullable

This will be true if the user doesn't have access to the project. In that case the description will be shadowed.

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 PutProjectTimeBooking removed and replaced with timeBookings_PutProjectTimeBooking