'get_quota_data' Response

The 'get_quota_data' returns the Quota View data for the selected bucket or group of capacity buckets. The 'get_quota_data' response contains one or several 'bucket' elements containing the properties of the specified bucket(s).

The following table describes the 'bucket' Element of 'get_quota_data' Response.

'bucket' Element of 'get_quota_data' Response

Name	Type	Description
bucket_id	string	external ID of the capacity bucket. If the 'aggregate_results' option is returned, the 'bucket_id' field is not returned
name	string	name of the capacity bucket. If the 'aggregate_results' option is returned, the 'name' field is not returned
day	array	array of 'day' elements each containing the quota data for a single day

Name

Type

Description

bucket_id

string

external ID of the capacity bucket.

If the 'aggregate_results' option is returned, the 'bucket_id' field is not returned

name

string

name of the capacity bucket.

If the 'aggregate_results' option is returned, the 'name' field is not returned

day

array

array of 'day' elements each containing the quota data for a single day

'day' Element of 'get_quota_data' Response

Name	Type	Description
date	date	date for which the quota data is returned
quota_percent	float	quota value defined as percent (returned when in Manage Application → Settings → Resource Info the 'Quota is entered for' field is set to 'day' and 'Quota is entered' field is set to 'as % of capacity available by calendar' at the day level)
min_quota	int
quota	int	quota value (in minutes) (
status	unsignedByte	status of the corresponding quota cell This field is a bitmask which contains the following flags: * 1 – Quota status is 'closed' * 4 – Quota is auto-closed * 8 – Quota was closed on a higher level * 16 – Quota is locked * 32 – Quota total is locked Individual bits can be checked using binary AND operator. For example in java/c++: status = 33; // binary '100001' if( status & 1 ) // bit 1 is set (Quota status is 'closed') if( status & 32 ) // bit 32 is set (returned when in Manage Application → Settings → Resource Info the 'Quota can be closed for' field is set for 'day')
close_time	DateTime	time when quota is to be closed automatically in the time zone of the selected capacity bucket. The 'close_time' field value contains both the date and time of quota closing in the YYYY-MM-DD HH:MM:SS format (returned when in Manage Application → Settings → Resource Info the 'Quota can be closed for' field is set for 'day')
closed_at	DateTime	time when quota was closed for the corresponding cell in the YYYY-MM-DD HH:MM:SS format (returned when in Manage Application → Settings → Resource Info the 'Quota can be closed for' field is set for 'day')
max_available	int	total working time of the resources in the capacity bucket on the selected day (in minutes) (returned when in Manage Application → Settings → Resource Info the 'Estimate maximum capacity for' option is set for 'day')
other_activities	int	total travel time and duration of all activities which are not part of capacity management (in minutes) (returned when in Manage Application → Settings → Resource Info the 'Estimate maximum capacity for' option is set for 'day' and the 'Estimate capacity used by activities that are not a part of the Quota Management' option is enabled at the day level)
used	int	used capacity (in minutes)
used_quota_percent	float	percentage of the daily quota currently used by the booked activities
count	int	number of booked activities
time_slot	array	array of 'time_slot' elements each containing the quota data for a single time slot
total	struct	total value calculated on the day level including all dependent time slots

'total' Element at 'Day' Level

Name	Type	Description
quota	string	total quota value for the day including all dependent time slots (in minutes)
max_available	int	total working time of the resources in the capacity bucket on the selected day including all dependent time slots (in minutes) (returned when in Manage Application → Settings → Resource Info the 'Estimate maximum capacity for' option is set for 'day')
other_activities	int	total travel time and duration of all activities which are not part of capacity management for the day (returned when in Manage Application → Settings → Resource Info the 'Estimate maximum capacity for' option is set for 'day' and the 'Estimate capacity used by activities that are not a part of the Quota Management' option is enabled at the day level)
used	int	total used capacity for the day (in minutes)
count	int	total number of booked activities for the day

If none of the above parameters are sent in the 'time_slot_quota_field' array of the request, the 'total' element will be empty.

'time_slot' Element of 'get_quota_data' Response

Name	Type	Description
label	string	label of the time slot
quota_percent	float	quota value defined as percent (returned when in Manage Application → Settings → Resource Info the 'Quota is entered for' field is set to 'time slot' and the 'Quota is entered' field is set to 'as % of the maximum time slot capacity' or 'as % of the daily quota' at the time slot level)
min_quota	int
quota	int	quota value (in minutes) (
stop_booking_at	unsignedShort	percent of the used daily quota to stop booking activities at (returned when in Manage Application → Settings → Resource Info tthe 'Allow to close based on % of the daily quota that is currently in use' option is enabled)
status	unsignedByte	status of the corresponding quota cell This field is a bitmask which contains the following flags: * 1 – Quota status is 'closed' * 4 – Quota is auto-closed * 8 – Quota was closed on higher level * 16 – Quota is locked * 32 – Quota total is locked Individual bits can be checked using binary AND operator. For example in java/c++: status = 33; // binary '100001' if( status & 1 ) // bit 1 is set (Quota status is "closed") if( status & 32 ) // bit 32 is set (returned when in Manage Application → Settings → Resource Info the 'Quota can be closed for' field is set for 'time slot')
close_time	DateTime	time when quota is to be closed automatically in the time zone of the selected capacity bucket. The 'close_time' field value contains both the date and time of quota closing in the YYYY-MM-DD HH:MM:SS format (returned when in Manage Application → Settings → Resource Info the 'Quota can be closed for' field is set for 'time slot')
closed_at	DateTime	time when quota was closed for the corresponding cell in the YYYY-MM-DD HH:MM:SS format (returned when in Manage Application → Settings → Resource Info the 'Quota can be closed for' field is set for 'time slot')
max_available	int	maximum capacity available in the selected time slot (in minutes) (returned when in Manage Application → Settings → Resource Info the 'Estimate maximum capacity for' field is set for 'time slot')
other_activities	int	total travel time and duration of all activities which are not part of capacity management and may affect capacity in the selected time slot (in minutes) (returned when in Manage Application → Settings → Resource Info the 'Estimate maximum capacity for' field is set for 'time slot' and the 'Estimate capacity used by activities that might affect capacity in this time slot' option is enabled at the time slot level)
used	int	used capacity (in minutes)
used_quota_percent	float	percentage of the time slot quota currently used by the booked activities in the same time slot
count	int	number of booked activities
category	array
total	array	total value calculated on the 'time slot' level' including all dependent capacity categories

'total' Element at 'Time Slot' Level

Name	Type	Description
quota	string	total quota value for the time slot (in minutes)
max_available	int	total maximum capacity available in the selected time slot (in minutes) (returned when in Manage Application → Settings → Resource Info the 'Estimate maximum capacity for' field is set for 'time slot')
used	int	total used capacity in the selected time slot (in minutes)
count	int	total number of booked activities in the selected time slot
plan	int	total planned workload for the selected time slot received from the Forecasting module (returned when in Manage Application → Company Settings → Display the 'Enable Plan column that shows data set in Forecasting' option is enabled)

If none of the above parameters are sent in the 'category_quota_field' array of the request, the 'total' element will be empty.

'category' Element of 'get_quota_data' Response

Name	Type	Description
label	string	label of the capacity category
quota_percent	float	quota value defined as percent (returned when in Manage Application → Settings → Resource Info the 'Quota is entered for' field is set to 'capacity category' and the 'Quota is entered' field is set to 'as % of the maximum capacity available in this category' or 'as % of the time slot quota' at the capacity category level)
min_quota	int	minimum value of the quota (in minutes) (returned when in Manage Application → Settings → Resource Info the 'Quota is entered for' field is set to 'capacity category' and the 'Quota is entered' field is set to 'as % of the maximum capacity available in this category' or 'as % of the time slot quota' at the capacity category level)
quota	int	quota value (in minutes) (returned when the 'Quota is entered for' field is set to 'capacity category')
stop_booking_at	unsignedShort	percent of the used time slot quota to stop booking activities at (returned when in Manage Application → Settings → Resource Info the 'Quota can be closed for' field is set for 'capacity category' and the 'Allow to close based on % of the daily quota that is currently in use' option is enabled at the capacity category level)
weight	float	weight of the capacity category calculated on the basis of historical data (returned when in Manage Application → Settings → Resource Info the 'Quota is entered' field is set for 'as % of time slot quota' and the 'Estimate quota based on historical data' option is enabled at the capacity category level)
estimated_quota_percent	float	estimated quota value (as percent) calculated on the basis of the 'weight' coefficient and the configuration of available resources on the selected day (returned when in Manage Application → Settings → Resource Info the 'Quota is entered' field is set for 'as % of time slot quota' and the 'Estimate quota based on historical data' option is enabled at the capacity category level)
status	unsignedByte	status of the corresponding quota cell This field is a bitmask which contains the following flags: * 1 – Quota status is "closed" * 4 – Quota is auto-closed * 8 – Quota was closed on higher level * 16 – Quota is locked * 32 – Quota total is locked Individual bits can be checked using binary AND operator. For example in java/c++: status = 33; // binary '100001' if( status & 1 ) // bit 1 is set (Quota status is "closed") if( status & 32 ) // bit 32 is set (returned when in Manage Application → Settings → Resource Info the 'Quota can be closed for' field is set for 'capacity category')
close_time	DateTime	time when quota is to be closed automatically in the time zone of the selected capacity bucket. The 'close_time' field value contains both the date and time of quota closing in the YYYY-MM-DD HH:MM:SS format (returned when in Manage Application → Settings → Resource Info the 'Quota can be closed for' field is set for 'capacity category')
closed_at	DateTime	time when quota was closed for the corresponding cell in the YYYY-MM-DD HH:MM:SS format (returned when in Manage Application → Settings → Resource Info the 'Quota can be closed for' field is set for 'capacity category')
max_available	int	maximum capacity available in the selected time slot and capacity category (in minutes) (returned when in Manage Application → Settings → Resource Info the 'Estimate maximum capacity for' field is set for 'capacity category')
used	int	used capacity (in minutes)
used_quota_percent	float	percentage of the capacity category quota currently used by the booked activities belonging to the same capacity category
count	int	number of booked activities
plan	int	planned workload received from the Forecasting module (returned when in Manage Application → Company Settings → Display the 'Enable Plan column that shows data set in Forecasting' option is enabled)
work_zone	array	array of properties containing the quota data for a work zone

'work_zone' Array of 'get_quota_data' Response

Name	Type	Description
label	string	label of the work zone
status	unsignedByte	status of the corresponding quota cell This field is a bitmask which contains the following flags: * 1 – Quota status is "closed" * 2 – Quota status is "open" * 4 – Quota is auto-closed * 8 – Quota was closed on higher level * 16 – Quota is locked * 32 – Quota total is locked Individual bits can be checked using binary AND operator. For example in java/c++: status = 33; // binary '100001' if( status & 1 ) // bit 1 is set (Quota status is "closed") if( status & 32 ) // bit 32 is set (returned when in Manage Application → Settings → Resource Info the 'Quota can be closed for' field is set for 'work zone')
close_time	DateTime	time when quota is to be closed automatically in the time zone of the selected capacity bucket. The 'close_time' field value contains both the date and time of quota closing (returned when in Manage Application → Settings → Resource Info the 'Quota can be closed for' field is set for 'work zone')
closed_at	DateTime	time when quota was closed for the corresponding cell (returned when in Manage Application → Settings → Resource Info the 'Quota can be closed for' field is set for 'work zone')