GET v1/bunits/{bunitId}/reports?type={type}
Get all status reports of the business unit. Use these to see development over time in summary details like data usage or nodes.
As such, these reports will not be customized for the requesting user because they do not contain node reports.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
bunitId |
The ID of the business unit | integer |
Required |
type |
The type of the status reports. Options are combined (default), resale and internal | string |
Default value is combined |
Body Parameters
None.
Response Information
Resource Description
Collection of StatusReportName | Description | Type | Additional information |
---|---|---|---|
BusinessUnit |
Business unit the report concerns |
BusinessUnit |
None. |
BusinessUnitName |
The name of the business unit at the time of reporting. |
string |
None. |
Descendants |
How many descendants are in the tree below this business unit |
integer |
None. |
Customers |
How many business units are invoiced by this business unit |
integer |
None. |
Contracts |
How many contracts are in the tree below this business unit |
integer |
None. |
HasContract |
Whether or not the business unit has a contract |
boolean |
None. |
Status |
Worst status of any nodes in the report |
ErrorStatus |
None. |
Summaries |
List of summaries |
Collection of StatusReportSummaryDetailed |
None. |
ParentReport |
Report of parent business unit |
StatusReport |
None. |
ChildReports |
List of status reports of children |
Collection of StatusReport |
None. |
Warnings |
Warnings are collected during reporting. You can specify which warnings are errors and cause alarms for report recipients. |
Collection of StatusReportWarning |
None. |
ReportDate |
The date of reporting. |
date |
None. |
UpdateTime |
Latest time the status report was update. |
date |
None. |
Id |
A unique ID for the object. |
integer |
Read-only. |
CreatedDate |
Time and date the object was created. |
date |
Read-only. |
ArchivedDate |
Time and date the object was or is going to be archived. Unarchived objects have no value in ArchivedDate |
date |
Read-only. |
Operations |
Collection of OperationResult |
None. |
|
NodeReports |
Collection of all node reports for the status report |
Collection of NodeReport |
None. |
Response Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.