GET v1/bunits/{bunitId}/reports/{reportDate}?userId={userId}&viewId={viewId}&logLevel={logLevel}
Get status report for a business unit.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
bunitId |
The id of the business unit | integer |
Required |
reportDate |
the date of the report | date |
Required |
userId |
Customize the report for this specific user instead of requesting user | integer |
None. |
viewId |
Optional parameter that lets the user choose a shared view. This will override user or business unit filter and error settings | integer |
None. |
logLevel |
Include backup node report content and set the level of information contained in activity logs. Options are null/undefined (default - content is not included), "none" or "full". | string |
Default value is |
Body Parameters
None.
Response Information
Resource Description
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.