Get Reports
get
/api/report/Reports
Gets a list of all reports and their attributes that match the specified parameters. If no parameters are specified, all reports and their attributes are returned.
Request
Query Parameters
-
filter: object
The fields to filter the results by. You cannot filter by fields that contain a state.
This parameter's value uses the following JSON format:
{
"property": "property",
"value": "propertyValue",
"operator": "operator",
"conjunction": "conjunction"
}
If you use multiple JSON objects to combine filters, for example, to filter by several different device names, you cannot combine OR and AND conjunctions. The conjunction used for the last object applies to the entire list.-
conjunction:
string
Default Value:
OR
Allowed Values:[ "AND", "OR" ]
The conjunction between filters.Example:AND
-
operator:
string
Default Value:
LIKE
Allowed Values:[ "eq", "ne", "gte", "gt", "lte", "lt", "LIKE", "NOT LIKE", "re", "not re", "NOT IN" ]
The filter operation to use.Example:eq
-
property(required):
string
The name of the field to filter on.Example:
name
-
value(required):
string
The value of the field to filter on.Example:
test
-
conjunction:
string
-
limit: integer(int32)
The number of records to limit results by.Example:
100
-
sort: object
The field and direction to sort results by. You cannot sort by fields that contain a state.
This parameters value uses the following JSON format:
{
"property": "property",
"direction": "direction"
}-
direction(required):
string
Allowed Values:
[ "ASC", "DESC" ]
The direction of the sort.Example:ASC
-
property(required):
string
The field to sort on.Example:
name
-
direction(required):
string
-
start: integer(int32)
The page of results to start from.Default Value:
0
Example:1
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulGetOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Loaded 1 entries
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
data: array
data
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : reportReportsRead
Type:
Show Source
object
-
AppendDateTime: integer
Flag to indicate if the date and time should be appended to the report name.Example:
1
-
BrokerComponentID: integer
Broker component that will carry out generation of the reportExample:
55
-
DashboardID: integer
Dashboard that serves as the basis for the report contentExample:
28
-
DashboardName: string
Dashboard name that serves as the basis for the report contentExample:
Adhoc Event Dashboard
-
Days: string
The day of the month when the report will be run. Valid entries are "*" which means every day, numbers between 1 and 31 to run on that day of the month, or "*/" can be used to indicate "Every number of days".Example:
*
-
Extension: string
Report output format Allowed Values: - png - pdf - csv - xlsx - xls - htmlExample:
pdf
- Footer: string
-
FullName: string
User Group nameExample:
Administrator
-
Hours: string
The hours when the report will be run. Valid entries are "*" which means every hour, numbers between 0 and 23 to run at that hour, or "*/" can be used to indicate "Every number of hours".Example:
0
-
LastRun: string
Last time the report generator was run.Example:
2022-11-22 11:43:00
-
Minutes: string
The minutes when the report will be run. Valid entries are "*" which means every minute, numbers between 0 and 59 to run at that minute, or "*/" can be used to indicate "Every number of minutes".Example:
0
-
Months: string
The month when the report will be run. Valid entries are "*" which means every month, numbers between 1 and 12 to run at that minute, or "*/" can be used to indicate "Every number of months".Example:
*
-
OwnerUserGroupID: integer
The user group that owns the report. If an associated report Profile has archiving enabled, the archived file will also be owned by this group.Example:
0
-
OwnerUserID: integer
The user that owns the report. If an associated Profile enables archiving, the archived file will also be owned by this user.Example:
0
-
Recipients: string
Email addresses the report notification should be sent to when the report is run.Example:
example@t.c
-
RenderTimeout: integer
The number of seconds to allow the report to render before capturing the results for the report.Example:
3
-
ReportID: integer
Report IDExample:
1000
-
ReportName: string
The title to identify the report at a glance.Example:
Sample
-
ReportParameters: string
Parameters to pass to the portalExample:
DeviceID=1
-
ReportProfileID: integer
Report profile that provides the generic configuration of the reportExample:
2
-
ReportProfileName: string
Report profile that provides the generic configuration of the reportExample:
Sample Attachment Profile
-
RunAsUserGroupID: integer
The Unified Assurance user group that will run the report. The user group's permissions will be used to determine what data can be included.Example:
1
-
RunAsUserID: integer
The Unified Assurance user that will run the report. The user's permissions will be used to determine what data can be included.Example:
1
-
State: integer
StateExample:
0
-
Status: string
The state of the report.Example:
Enabled
-
StatusIcon: string
Status IconExample:
OrbGreen.png
-
StatusID: integer
Flag indicating whether the report is being run according to its schedule or not Allowed Values: - 0 => Disabled - 1 => EnabledExample:
1
-
UserName: string
User NameExample:
admin
-
Viewers: array
Viewers
The user groups that will also have access to the report.
-
WeekDays: string
The day of the week when the report will be run. Valid entries are "*" which means every day of the week, numbers between 0 and 7 (0/7 = Sunday, 1 = Monday, 2 = Tuesday, 3 = Wednesday, 4 = Thursday, 5 = Friday, 6 = Saturday), or "*/" can be used to indicate "Every number of days".Example:
*
Nested Schema : Viewers
Type:
array
The user groups that will also have access to the report.
Show Source
Nested Schema : items
Type:
Show Source
object
-
UserGroupID: integer
User Group IDExample:
0
-
UserGroupName: string
User Group NameExample:
[Public to All Groups]
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
errors: array
errors
The list of errors reported. Validation errors will be keyed by record field.
-
message: string
The response message.Example:
Exception thrown
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
false
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object