Allocations

Get an allocation

get/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

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.