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

• http://localhost:8080/uc/resources/report/run?reporttitle=testReport

• http://localhost:8080/uc/resources/report/run?reporttitle=testReport&visibility=Me

• http://localhost:8080/uc/resources/report/run?reporttitle=testReport&visibility=Group&groupname=testGroup

• http://localhost:8080/uc/resources/report/run?reporttitle=testReport&visibility=Everyone

Authentication

HTTP Basic

Example Responses

See Run Report Examples, below.

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:

• 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.

N