Projects Create User Assignment
projects_create_user_assignmentAssign a user to a project, phase or leave type on the documented route POST /users/{user_id}/assignments (dates: YYYY-MM-DD).
Instructions
Assign a user to a project, phase or leave type on the documented route POST /users/{user_id}/assignments (dates: YYYY-MM-DD).
assignable_id is the project, phase or leave type ID. Set allocation_mode and the matching value:
percent (the reference documents it as a fraction from 0 to 1), hours_per_day, or fixed_hours for the
fixed mode. allocation_mode is sent as given, because the reference names the fixed mode fixed in
its description and fixed_hours in its schema. Percent mode is the default and requires percent;
hours_per_day and the fixed mode require hours_per_day and fixed_hours. Without the matching value
the call is refused before any request.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| percent | No | Share of the user's time as a fraction from 0 to 1. Required when allocation_mode is `percent`, which is the default; without it the call is refused before any request is sent. | |
| user_id | Yes | ||
| end_date | Yes | ||
| start_date | Yes | ||
| description | No | ||
| fixed_hours | No | ||
| bill_rate_id | No | ||
| assignable_id | Yes | ||
| hours_per_day | No | ||
| allocation_mode | No | Allocation mode, sent unchanged: `percent` (the default; `percent` is then required), `hours_per_day` (`hours_per_day` is then required), or the fixed mode, which the API reference names `fixed` in its description and `fixed_hours` in its enum (`fixed_hours` is then required). | percent |
| status_option_id | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |