Overview

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

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

Run Report

	Description

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

Parameter	Description	Specifications	Required

Parameter

Description

Specifications

Required

groupname

If visibility = Group; Name of a user group.

To run a report that is visible to multiple groups, you can specify any one of the groups that the report is visible to.

N

reporttitle

Title of the Report.

Y

visibility

Users that will be able to view this report.

Valid Values:

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 (any group 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

XML	JSON	CSV

XML	JSON	CSV
`<report> <rows rowCount="2"> <row> <columns> <column label="Task Name">t1</column> <column label="Type">Workflow</column> <column label="Task Description" /> </columns> </row> <row> <columns> <column label="Task name">t2</column> <column label="Type">Workflow</column> <column label="Task Description" /> </columns> </row> </rows> <title>test report</title> <totalRows>2</totalRows> </report>`	`{ "rows": { "rowCount": 2, "rows": [ { "columns": [ { "label": "Task Name", "value": "t1" }, { "label": "Type", "value": "Workflow" }, { "label": "Task Description", "value": "" } ] }, { "columns": [ { "label": "Task Name", "value": "t2" }, { "label": "Type", "value": "Workflow" }, { "label": "Task Description", "value": "" } ] } ] }, "title": "test report", "totalRows": 2 }`	`Task Name,Type,Task Description t1,Workflow,, t2,Workflow,,`