Report Web Services
Universal Controller supports the following RESTful-based web service for Report.
Formatting specifications for the web service, including details about parameter requirements, are provided.
List Reports
Description | |
|---|---|
URI | http://host_name/uc/resources/report |
HTTP Method | GET |
Description | Retrieves information on the specified report. |
Example URI |
|
Authentication | HTTP Basic |
Produces Content-Type | Application/JSON |
Consumes Content-Type | N/A |
Example Responses |
|
List Reports: URI Parameters
Parameter | UI Field Name | Description | Specifications | Required | Mutually Exclusive With |
|---|---|---|---|---|---|
| n/a | Indicate whether or not to include Field Labels information in the response. | Type = Boolean (true/false), Default is false; URI property. | N | |
| n/a | If | To read a report that is visible to multiple groups, you can specify any one of the groups that the report is visible to. | Y (if | |
| Table | Table Name | Valid values: Table Name of the list of Reportable Tables. | N | |
| Title | Title of the Report. | Wildcards are supported. | Y | |
| Type | Type of report | Valid values:
| N | |
| Updated By | Username of the Updated By user. | Type = String; URI property. | N | |
| n/a | If | Valid values:
Default is d. Examples: -5d (last 5 days), -30mn (last 30 minutes), -6h (last 6 hours), -7 (last 7 days). If If info The time is relative to the Time Zone specified for the User. | Y (if | |
| n/a | Type of | Valid values:
| N | |
| n/a | If | Y (if | ||
| n/a | Users that will be able to view this report. | Valid Values:
If there are multiple reports with the same title:
| N |
Read a Report
Description | |
|---|---|
URI | http://host_name/uc/resources/report |
HTTP Method | GET |
Description | Retrieves information on the specified report. |
Example URI | |
Authentication | HTTP Basic |
Produces Content-Type | Application/JSON |
Consumes Content-Type | N/A |
Example Responses |
|
Read a Report: URI Parameters
Parameter | UI Field Name | Description | Specifications | Required | Mutually Exclusive With |
|---|---|---|---|---|---|
| n/a | If | To read a report that is visible to multiple groups, you can specify any one of the groups that the report is visible to. | Y (if |
|
| n/a | Indicate whether or not to include Field Labels information in the response. | Type = Boolean (true/false), Default is false; URI property. | N | |
| UUID | ID used within the Controller to identify this Report. | N |
| |
| Title | Title of the Report. | N |
| |
| n/a | If visibility = User; Username of a user. | Y (if |
| |
| n/a | Users that will be able to view this report. | Valid Values:
If there are multiple reports with the same title:
| N |
|
Run Report
Description | |
|---|---|
URI | http://host_name/uc/resources/report/run |
HTTP Method | GET |
HTTP Header | Accept
|
Description | Run report. Chart reports are generated in png format ("image/png") List reports are generated in pdf format (application/pdf), by default.
|
URI Parameters | See Run Report: URI Parameters, below. |
Example URI |
|
Authentication | HTTP Basic |
Example Responses | See Run Report Examples, below. |
Run Report: URI Parameters
Parameter | UI Field Name | Description | Specifications | Required | Mutually Exclusive With |
|---|---|---|---|---|---|
| n/a | If | 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 | |
| UUID | ID used within the Controller to identify this Report. | N |
| |
| Title | Title of the Report. | Y | ||
| n/a | If visibility = User; Username of a user. | Y (if |
| |
| n/a | Users that will be able to view this report. | Valid Values:
If there are multiple reports with the same title:
| N |
Run Report Examples
- JSON
- XML
- CSV
JSON
{
"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
}
XML
<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>
CSV
Task Name,Type,Task Description
t1,Workflow,,
t2,Workflow,,
Properties
Report Properties
Property | UI Field Name | Description | Specifications | Required |
|---|---|---|---|---|
| Average Color | Specifies the hexadecimal color of the average line. If unspecified, the color is determined by the Report Average Color system property. | n/a | |
| Bar Thickness | The maximum thickness of a bar chart column. | Integer. | n/a |
| Chart Size | Option to specify the size of the chart. Not applicable when report is rendered as a widget. | Valid values:
| n/a |
| Description | Description of this record. Maximum length is 255 characters. | n/a | |
| n/a | A map containing name-label information for each field. | Read-Only. Included in the Read or List response only if | n/a |
| Field(s) | List of visible fields. | n/a | |
| Group | Visible To group. | n/a | |
| Group By | Field in the selected Universal Controller table by which you want to group the fields in the report. | n/a | |
| Group Date/Time Format | Determines the formatting of the Group By field value when grouping by a Date/Time field. | Valid values:
| n/a |
| Group Order | Option to order groups by label or by count. | Valid values:
| n/a |
| Groups | List of Visible To groups. | | n/a |
| Group Threshold | Determines the maximum number of groups to display on the chart. All remaining groups will be summed and displayed as the "Other" group. | Valid values:
| n/a |
| Image Height | Override the default image height for the scheduled chart report. | Integer. | n/a |
| Image Width | Override the default image width for the scheduled chart report. | Integer. | n/a |
| PDF Orientation | If | Valid values:
| n/a |
| PDF Size | If | Valid values:
| n/a |
| Table Title | Table title. | Read-Only. | n/a |
| Table | Universal Controller Reportable table in the Controller database on which the Report is based. | n/a | |
| Show Average | Specifies whether to display the average line on the bar chart. | Boolean; Valid values: true/false. Default is false. | n/a |
| Show Threshold | Specifies whether to display the threshold line on the bar chart. | Boolean; Valid values: true/false. Default is false. | n/a |
| Sort By | List of sort specifiers. | See Sort Specifier Properties, below. | n/a |
| Stack By | Field in the selected Universal Controller table by which you want to sort records within each Group. | n/a | |
| Sum Field | Sum of the integers in the field in the selected Universal Controller table by which you want to group the fields in the report. | n/a | |
| UUID | Universally Unique Identifier of this record. | n/a | |
| System Report | Specifies whether or not this is a built-in report. | Boolean; Valid values: true/false. Default is false. | n/a |
| Title | Title (name) of the Report. | n/a | |
| Threshold Color | Specifies the hexadecimal color of the threshold line. If unspecified, the color is determined by the Report Threshold Color system property. | n/a | |
| Threshold Label | Specifies the label for the threshold line. If unspecified, the label will be "Threshold". | n/a | |
| Threshold Value | Specifies the integer value for the threshold line. | Integer. | n/a |
type | Type | Type of report. | Valid values:
| n/a |
| User | Visible To user. | n/a |
Sort Specifier Properties
Property | UI Field Name | Description | Specifications | Required |
|---|---|---|---|---|
| n/a | Sort direction. | Valid values (case-insensitive):
| n/a |
| n/a | Name of the Sort By field. | n/a |