Allocations

Update an allocation

patch/allocations/{id}

Request

  • Base URL: https://www.ruddr.io/api/workspace
  • URL: https://www.ruddr.io/api/workspace/allocations/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The allocation uuid

Request body

resourceTypeId'member' | 'placeholder'

The type of resource being assigned. Must be either "member" for a real team member or "placeholder" for a generic resource placeholder.

assignmentTypeId'project' | 'time_off'

The type of assignment. Must be either "project" for a project-related allocation or "time_off" for a time off assignment.

startstring date

The start date (YYYY-MM-DD) of the allocation, must come on or before end date.

endstring date

The end date (YYYY-MM-DD) of the allocation, must come on or after the start date.

unit'day' | 'week' | 'month' | 'allocation' | 'ratio_of_capacity'

The time unit that determines how the allocation is defined. Possible values are "day" (Per day), "week" (Per week), "month" (Per month), "allocation" (Absolute number of hours), or "ratio_of_capacity" (Percentage of available capacity).

hoursPerDaynumber nullable

The number of hours allocated per day. Only allowed when unit is day. Must be between 0 and 24 with up to 2 decimal places.

hoursPerWeeknumber nullable

The number of hours allocated per week. Only allowed when unit is week. Must be between 0 and 168 with up to 2 decimal places.

hoursPerMonthnumber nullable

The number of hours allocated per month. Only allowed when unit is month. Must be between 0 and 744 with up to 2 decimal places.

hoursPerAllocationnumber nullable

The total number of hours allocated for the full duration. Only allowed when unit is allocation. Must be between 0 and 99999 with up to 2 decimal places.

hoursRatioOfCapacitynumber nullable

The proportion of the member's available capacity to allocate. Only allowed when unit is ratio_of_capacity. Must be between 0 and 1 with up to 4 decimal places.

allocateOnTimeOffDaysboolean nullable

Whether time can be allocated on days when the member has time off. Defaults to false if not provided.

bookingTypeId'confirmed' | 'soft'

The booking type of the allocation. Defaults to confirmed if not provided.

notesstring nullable

Any notes with the associated allocation.

memberIdstring nullable

The member ID (uuid) of the member for this allocation. Must be provided if the resourceTypeId is member.

resourcePlaceholderIdstring nullable

The resource placeholder ID (uuid) of the resource placeholder for this allocation. Must be provided if the resourceTypeId is placeholder.

projectIdstring nullable

The project ID (uuid) of the project for the allocation. Must be provided if the assignmentTypeId is project.

projectRoleIdstring nullable

The project role ID (uuid) of the project role for the allocation. May be required depending on the project configuration.

projectTaskIdstring nullable

The project task ID (uuid) of the project task for the allocation.

timeOffTypeIdstring nullable

The time off type ID (uuid) of the time off type for the allocation. Must be provided if the assignmentTypeId is time_off.

Response

200

idstring

The unique identifier for the object.

resourceTypeId'member' | 'placeholder'

The type of resource assigned to this allocation.

assignmentTypeId'project' | 'time_off'

The type of assignment for this allocation.

startstring date

The start date of the allocation. Will be in the form YYYY-MM-DD.

endstring date

The end date of the allocation. Will be in the form YYYY-MM-DD.

unit'day' | 'week' | 'month' | 'allocation' | 'ratio_of_capacity'

The time unit that determines how the allocation is measured.

hoursPerDaynumber nullable

The number of hours allocated per day. Only present when unit is "day", otherwise null.

hoursPerWeeknumber nullable

The number of hours allocated per week. Only present when unit is "week", otherwise null.

hoursPerMonthnumber nullable

The number of hours allocated per month. Only present when unit is "month", otherwise null.

hoursPerAllocationnumber nullable

The total number of hours for the entire allocation duration. Only present when unit is "allocation", otherwise null.

hoursRatioOfCapacitynumber nullable

The proportion of the member's available capacity allocated. Only present when unit is "ratio_of_capacity", otherwise null.

allocateOnTimeOffDaysboolean nullable

Whether time is allocated on days when the member has time off. Only present when assignmentTypeId is "project" and resourceTypeId is "member", otherwise null.

totalHoursnumber

The total number of computed hours across all dates in the allocation.

isBillableboolean

Whether this allocation is billable.

bookingTypeId'confirmed' | 'soft'

The booking type of the allocation.

notesstring nullable

Notes associated with the allocation.

readOnlyboolean

Whether this allocation is read-only. Allocations sourced from time entries or holidays are read-only.

entity'allocation' | 'time_entry' | 'holiday'

The source entity type.

createdAtstring date-time

The timestamp when the object was created.

modifiedAtstring date-time nullable

The timestamp when the object was last modified. null for time-entry and holiday allocations, which are derived and have no modification timestamp.

Changes

No recorded changes to this operation across all 1 revision of this API.