Query the planned, available and actual utilization of resources in a given time period.
Businesses have their own way of organizing resource utilization data and this function provides a flexible way to achive that. Although XML could have been used to organize the information hierarchicaly thereby reducing the size of the data by avoiding duplication, we have deliberately returned the data as 'rows'. We think that the best way to use this information is to create temporary SQL tables on your client side, insert the data returned into those tables and then use the power of SQL to query to generate suitable output.
query-utilization
from (Required). Date from which utilization
is required.
to (Required). Date till which utilization is required.
project_id (Optional). Only include data for project with this ID.
project_phase_ids (Optional). Only include data for projects with these phase ids.
zoom (Optional). Groups utilization data by day, week or month (the default). Valid values: 5 for Day, 3 for Week and 2 for Month.
user_id (Optional). Only include data for user with this ID.
In case of XML data format, you will be returned an XML string
with two elements: count (the number of rows) and
rows (this will contain multiple row
elements). For example :
<result>
<rows>
<row>
<f>
<v>3360</v> <!-- Planned minutes for this task for this period -->
<n>planned</n>
</f>
<f>
<v>1200</v> <!-- Actual minutes for this task for this period -->
<n>actual</n>
</f>
<f>
<v>10560</v> <!-- Available minutes for this resource in this period (incl. holidays and vacations -->
<n>availability</n>
</f>
<f>
<v>27619</v>
<n>resource_id</n> <!-- ID of the resource -->
</f>
<f>
<v>Joe Cool</v>
<n>resource_name</n> <!-- Name of the resource -->
</f>
<f>
<v>998612</v>
<n>task_id</n> <!-- Name of the task -->
</f>
<f>
<v>43154</v>
<n>project_id</n> <!-- ID of the project -->
</f>
<f>
<v>Sample: Setting up office space</v> <!-- Name of the project -->
<n>project_name</n>
</f>
<f>
<v>In Progress</v> <!-- Project Phase -->
<n>project_phase_name</n>
</f>
<f>
<v>General</v> <!-- Category name -->
<n>project_category_name</n>
</f>
<f>
<v>Internal</v> <!-- Root client name -->
<n>client_root_name</n>
</f>
<f>
<v>2009-06-01T00:00:00</v> <!-- start date of the period -->
<n>period_start</n>
</f>
</row>
...
</rows>
</result>In case of JSON, it will return an object will
have the property rows (which will be an array of
objects with n and v properties
respectively)