API v1 ReferenceTime Bookings

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

Required Permissions
Any authenticated user.

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
idstring or nullformat: "uuid"
The id of the entity.
createdOndatetime or null
The date this entity was created.
createdBystring or nullformat: "uuid"
The id of the user who created this entity.
updatedOndatetime or null
The date this entity was last modified.
updatedBystring or nullformat: "uuid"
The id of the user who last modified this entity.
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.

startDatedate or null
The start date of the time booking.
endDatedate or null
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.

Errors