GET v1/bunits/{bunitId}/consumption?startDate={startDate}&endDate={endDate}&detailLevel={detailLevel}&includeConsumptionUnits={includeConsumptionUnits}&includeDescendants={includeDescendants}
Get consumptiondata related to a business unit.
This will include all consumption of
descendant business units and consumption units
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
bunitId |
The ID of the business unit | integer |
Required |
startDate |
The first desired date of the dataset | date |
Required |
endDate |
Optional: End date of the dataset. Default: Current date | date |
None. |
detailLevel |
Optional: Level of detail of the provided data. 1: All dates summarized, 2: All details (includes descriptions), 3: Summary of all consumption within the period. Default: 1 | integer |
Default value is 1 |
includeConsumptionUnits |
Optional: Includes the consumption of all consumption units as well as the business unit. Default: true | boolean |
Default value is True |
includeDescendants |
Optional: Include consumption of descending business units or only of the current business unit. Default: true | boolean |
Default value is True |
Body Parameters
None.
Response Information
Resource Description
Collection of ConsumptionDataName | Description | Type | Additional information |
---|---|---|---|
Product |
Which product the consumption concerns |
Product |
None. |
Consumptions |
Which consumption unit has been utilizing the product If consumption unit is null the utilization is related directly to the business unit |
Collection of Consumption |
None. |
Response Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.