API v1 ReferenceTime Bookings

Creates a new time booking for a given project and user.

<Check title="Required Permissions">Any authenticated user.</Check>

Headers

AuthorizationstringRequired

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

Request

The data to create a new time booking.
userIdstringOptionalformat: "uuid"
The id of the user this time booking is for.
projectIdstring or nullOptionalformat: "uuid"

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

startDatestringOptionalformat: "date"
The start date of this time booking.
endDatestringOptionalformat: "date"
The end date and time of this time booking.
durationintegerOptional

The duration (in seconds) of this time booking.

descriptionstring or nullOptional

The optional name/description for this time booking.

laneOrderintegerOptional

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 or nullformat: "uuid"
createdOnstring or nullformat: "date-time"
createdBystring or nullformat: "uuid"
updatedOnstring or nullformat: "date-time"
updatedBystring or nullformat: "uuid"
userIdstring or nullformat: "uuid"
The id of the user this time booking is for.
projectIdstring or nullformat: "uuid"

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

startDatestring or nullformat: "date"
The start date of the time booking.
endDatestring or nullformat: "date"
The end date of the time booking.
durationinteger or null
The planned duration, expressed in seconds, of this time booking.
descriptionstring or null
The optional description for this time booking.
laneOrderinteger or null

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

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