CapacityVisualizationMultiRequest
POST {{base_url}}/CapacityVisualizationMultiRequest
Retrieves a visual representation of bookings and how much capacity is available for multiple resources. For calls with task resources, hours used for the task is also included.
Requires Authentication
Yes
Returns
List [CapacityVisualization]
Batch?
No
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
References | string | Optional. | |
| The identifiers or list of identifiers of the task/resource elements. This includes optional start and end dates. |
Request Body
[{"name"=>"SummarizeVisualization", "value"=>"{{boolean}}", "datatype"=>"string"}, {"name"=>"IncludeTotalApproval", "value"=>"{{boolean}}", "datatype"=>"string"}, {"name"=>"IncludeIdealAndFlex", "value"=>"{{boolean}}", "datatype"=>"string"}, {"name"=>"IgnorePast", "value"=>"{{boolean}}", "datatype"=>"string"}, {"name"=>"IncludeAvailableCapacity", "value"=>"{{boolean}}", "datatype"=>"string"}, {"name"=>"IncludeAbsence", "value"=>"{{boolean}}", "datatype"=>"string"}, {"name"=>"PeriodType", "value"=>"{{integer}}", "datatype"=>"string"}, {"name"=>"IncludeCurrentHours", "value"=>"{{boolean}}", "datatype"=>"string"}, {"name"=>"CapacityUseFlexWhenUnlimited", "value"=>"{{boolean}}", "datatype"=>"string"}, {"name"=>"IncludeEmptyCapacity", "value"=>"{{boolean}}", "datatype"=>"string"}]
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string | Required. | |
| The type of content accepted by the API endpoint. | |||
Content-Type | string | Required. | |
| The type of content supported by the API endpoint. |
RESPONSES
status: OK
[[{"ReferenceId":0,"Id":0,"ResourceId":0,"ToDate":"0001-01-01T00:00:00.000Z","Capacity":0,"CapacityCurrent":0,"AvailableCapacity":0,"HoursBooked":0,"HoursBookedCurrent":0,"TotalHoursBooked":0,"TotalHoursBookedCurrent":0,"TotalApprovedHoursBooked":0,"TotalApprovedHoursBookedCurrent":0,"HoursNormal":0,"HoursIdeal":0,"HoursFlex":0,"BookingLevel":0,"DayType":0,"HoursHoliday":0}]]