Routes
Users
Capacity
Exceptions
Update Capacity Exception
This request updates an existing capacity exception and returns the updated resource.
capacityMinutes means the user's available capacity per day for each day in the exception date/range. It is not the total duration of the exception range.
Examples:
- capacityMinutes: 0 => unavailable that day (or each day in the range).
- capacityMinutes: 480 => 8 hours available per day.
Return data description
| Property | Description |
|---|---|
| exceptionID | Unique ID for the capacity exception record. |
| userID | The user the exception applies to. |
| createdByUserID | The user who created the exception. |
| exceptionStartDate | The first date the exception applies (YYYY-MM-DD). |
| exceptionEndDate | The last date the exception applies (YYYY-MM-DD). Null when the exception is only for one day. |
| capacityMinutes | Allowed capacity in minutes per day for the exception date/range. |
| hoursPerDay | Derived whole-hour portion of capacityMinutes. |
| minutesPerDay | Derived minute remainder after hoursPerDay. |
| exceptionTitle | Optional short title for the exception. |
| exceptionNotes | Optional notes/details for the exception. |
| exceptionType | Structured planned/unplanned classification (planned, unplanned, or null when unset). |
patch/v2/users/capacity/exceptions/{userID}/{exceptionID}
Request
- Base URL{{server}}:{{port}}
- AuthHTTP basic
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Request body
Response
Update Capacity Exception
Changes
No recorded changes to this operation across all 4 revisions of this API.