1. REST API for Unified Assurance Core
  2. Tasks
  3. Reports
  4. Reports

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
  • 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.
    • Default Value: OR
      Allowed Values: [ "AND", "OR" ]
      The conjunction between filters.
      Example: AND
    • 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
    • The name of the field to filter on.
      Example: name
    • The value of the field to filter on.
      Example: test
  • The number of records to limit results by. If you do not also set the start parameter, records start at 0.
    Example:
    100
  • 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" }
    Example:
    [
    {
        "property":"Name",
        "direction":"ASC"
    },
    {
        "property":"Value",
        "direction":"DESC"
    }
]
  • The page of results to start from. This parameter is ignored if you do not also set the limit parameter.
    Default Value: 0
    Example:
    1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : SuccessfulGetOperation
Type: object
The response body for a successful get operation.
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : data
Type: array
Show Source
Nested Schema : reportReportsRead
Type: object
Show Source
  • Flag to indicate if the date and time should be appended to the report name.
    Example: 1
  • Broker component that will carry out generation of the report
    Example: 55
  • Dashboard that serves as the basis for the report content
    Example: 28
  • Dashboard name that serves as the basis for the report content
    Example: Adhoc Event Dashboard
  • 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: *
  • Report output format Allowed Values: - png - pdf - csv - xlsx - xls - html
    Example: pdf
  • User Group name
    Example: Administrator
  • 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
  • Last time the report generator was run.
    Example: 2022-11-22 11:43:00
  • 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
  • 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: *
  • 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
  • The ID of the user that owns the report. If an associated Profile enables archiving, the archived file will also be owned by this user. This can never be an externally-authenticated transient user. 0 means it is public to all users in the owning group.
    Example: 0
  • Email addresses the report notification should be sent to when the report is run.
    Example: example@example.com
  • The number of seconds to allow the report to render before capturing the results for the report.
    Example: 3
  • Report ID
    Example: 1000
  • The title to identify the report at a glance.
    Example: Sample
  • Parameters to pass to the portal
    Example: DeviceID=1
  • Report profile that provides the generic configuration of the report
    Example: 2
  • Report profile that provides the generic configuration of the report
    Example: Sample Attachment Profile
  • 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
  • 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
    Example: 0
  • The state of the report.
    Example: Enabled
  • Status Icon
    Example: OrbGreen.png
  • The report status ID, indicating whether the report is being run (enabled,1), or not (disabled, 0.
    Example: 1
  • User Name
    Example: admin
  • Viewers
    The user groups that will also have access to the report.
  • 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: object
Show Source

Default Response

Failed operation
Body ()
Root Schema : schema
Type: object
Show Source
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
An error.
Back to Top