Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Universal Controller supports the following RESTful-based web service for Report.

Formatting specifications for the web service, including details about parameter requirements, are provided.

...


Description

URI

http://host_name/uc/resources/report/run

HTTP Method

GET

HTTP Header

Accept

  • application/pdf (Default)
  • application/xml
  • application/json
  • text/csv
  • text/tab-separated-values

Description

Run report.
 
Chart reports are generated in png format ("image/png")
 
List reports are generated in pdf format (application/pdf), by default.

  • To get the report in XML format, the Accept HTTP Header must be set to application/xml.
  • To get the report in JSON format, the Accept HTTP Header must be set to application/json.
  • To get the report in CSV format, the Accept HTTP Header must be set to text/csv.
  • To get the report in TSV format, the Accept HTTP Header must be set to text/tab-separated-values.

URI Parameters

See Run Report: URI Parameters, below.

Example URI

Authentication

HTTP Basic

Example Responses

See Report Web Services#Run Run Report Examples, below.

Anchor
Run Report URI Parameters
Run Report URI Parameters
Run Report: URI Parameters

<ul> <li> Me <li> Group <li> Everyone </ul>
  • Me
  • Group
  • Everyone

If there are multiple reports with the same title:

  • If visibility is not provided, reports are sorted in the following order:
    1. User visibility
    2. Group visibility (group(s) that the user running the report is a member of)
    3. Everyone visibility
  • If visibility is provided:
    • If visibility = Me, web service returns only the report that matches reporttitle and is visible to the user running the report.
    • If visibility = Group, web service returns only the report that matches reporttitle and is visible to the groupname.
    • If visibility = Everyone, web service returns only the report that matches reporttitle and is visible to Everyone.

Parameter

Description

Specifications

Required

groupname

If visibility = Group; Name of a specific user group.


N

reporttitle

Title of the Report.


Y

visibility

Users that will be able to view this report.

Valid Values:

Html bobswift

N

...