API v1 ReferenceTime Bookings

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

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

Authentication

AuthorizationBearer

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

Request

The model to create the 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.

startDatedateOptional
The start date of this time booking.
endDatedateOptional
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
idstringformat: "uuid"
The id of the entity.
createdOndatetime
The date this entity was created.
createdBystringformat: "uuid"
The id of the user who created this entity.
updatedOndatetime
The date this entity was last modified.
updatedBystringformat: "uuid"
The id of the user who last modified this entity.
userIdstringformat: "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.

startDatedate
The start date of the time booking.
endDatedate
The end date of the time booking.
durationinteger
The planned duration, expressed in seconds, of this time booking.
descriptionstring or null
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 or null
This will be true if the user doesn't have access to the project. In that case the description will be shadowed.

Errors

400
Bad Request Error
401
Unauthorized Error