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

Get Report Profiles

get

/api/report/Profiles

Gets a list of all report profiles and their attributes that match the specified parameters. If no parameters are specified, all report profiles 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 : reportProfilesRead
Type: object
Show Source
  • Checkbox to indicate whether the report results will be archived in the file repository or not. Allowed Values: - 0 => Disabled - 1 => Enabled
    Example: 1
  • Display of the archived reports. Allowed values: - Yes - No
    Example: Yes
  • Number of days to keep archived reports before they expire. It is Required when Archive is 1.
    Example: 30
  • Flag indicating whether the report runner should calculate width and height for the image or pdf Allowed Values: - 0 => Use user defined configuration - 1 => Autosize
    Example: 1
  • If Report Format is set to "Data Export", the type of file that is generated. Allowed Values: - Excel 2007+(*.xlsx) - Excel 97-2003(*.xls) - CSV - Hypertext(*.html) - PDF
    Example: Excel 2007+(*.xlsx)
  • The type of output the report will produce. Allowed Values: - PNG - PDF - Data Export
    Example: PDF
  • Height of the output in pixels
    Example: 1800
  • If Page Size is set to "Manual", a string explaining the page size to use in the PDF. Examples are "5in*7.5in", "10cm*20cm", "A4", "Letter".
    Example: Letter
  • The profile ID used to notify the recipients that the scheduled report is ready.
    Example: 1
  • The profile name used to notify the recipients that the scheduled report is ready.
    Example: Generic Email
  • The template ID used to notify the recipients that the scheduled report is ready.
    Example: 3
  • The template used to notify the recipients that the scheduled report is ready.
    Example: Unified Assurance Report - Attachment
  • Page orientation used by PDF Allowed Values: - Landscape - Portrait
    Example: Landscape
  • If Report Format is set to "PDF", the page size for the PDF to use. Allowed Values: - A4 - Letter - Manual
    Example: Letter
  • The type of output the report will produce. Allowed Values: - PNG - PDF - Data Export
    Example: PDF
  • Report Profile ID
    Example: 2
  • The identifier for the profile.
    Example: Sample Attachment Profile
  • Width of the output in pixels
    Example: 1024
  • PDF Zoom level needed to scale content
    Example: 1

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