The REST APIs to work with reports in Web Intelligence documents.
The tables below indicate the 4.0 and/or 4.1 release in which support for the API was introduced.
Base URL: http://<server_name>:6405/biprws/raylight/v1
Path parameters:
Query parameters: see the detailed description of the related API.
Action | Method | URL | Since |
---|---|---|---|
Creating a Report | POST | /documents/<documentID>/reports | 4.0 SP6 | 4.1 |
Getting the List of Reports | GET | /documents/<documentID>/reports | 4.0 SP5 | 4.1 |
Getting the Details of a Report | GET | /documents/<documentID>/reports/<reportID> | 4.0 SP5 | 4.1 |
Copying a Report | POST | /documents/<documentID>/reports | 4.0 SP6 | 4.1 |
Moving a Report | POST | /documents/<documentID>/reports?fromId=<fromID>&toId=<toID> | 4.0 SP6 | 4.1 |
Updating the Properties of a Report | PUT | /documents/<documentID>/reports/<reportID> | 4.0 SP6 | 4.1 |
Deleting a Report | DELETE | /documents/<documentID>/reports/<reportID> | 4.0 SP6 | 4.1 |
Exporting a Report in Listing Mode | GET | /documents/<documentID>/reports/<reportID> | 4.0 SP5 | 4.1 |
Exporting a Report as a Series of Pages | GET | /documents/<documentID>/reports/<reportID>/pages | 4.0 SP6 | 4.1 |
Exporting a Page of a Report | GET | /documents/<documentID>/reports/<reportID>/pages/<pageIndex> | 4.0 SP6 | 4.1 |
Getting the Map of a Report | GET | /documents/<documentID>/reports/<reportID>/map | 4.0 SP6 | 4.1 |
Getting the Structure of a Report | GET | /documents/<documentID>/reports/<reportID>/specification | 4.0 SP6 | 4.1 |
Updating the Structure of a Report | PUT | /documents/<documentID>/reports/<reportID>/specification | 4.0 SP6 | 4.1 |
Action | Method | URL | Since |
---|---|---|---|
Creating a Data Filter | POST | /documents/<documentID>/reports/<reportID>/datafilter | 4.1 SP2 |
Getting the Details of a Data Filter | GET | /documents/<documentID>/reports/<reportID>/datafilter | 4.1 SP2 |
Updating a Data Filter | PUT | /documents/<documentID>/reports/<reportID>/datafilter | 4.1 SP2 |
Deleting a Data Filter | DELETE | /documents/<documentID>/reports/<reportID>/datafilter | 4.1 SP2 |
Action | Method | URL | Since |
---|---|---|---|
Getting the Input Controls of a Report | GET | /documents/<documentID>/reports/<reportID>/inputcontrols | 4.1 SP3 |
Moving an Input Control from a Document to a Report | PUT | /documents/<documentID>/reports/<reportID>/inputcontrols?fromId=<fromID> | 4.1 SP6 |
Getting the Definition of an Input Control | GET | /documents/<documentID>/reports/<reportID>/inputcontrols/<inputControlID> | 4.1 SP3 |
Updating the Definition of an Input Control | PUT | /documents/<documentID>/reports/<reportID>/inputcontrols/<inputControlID> | 4.1 SP3 |
Adding an Input Control | POST | /documents/<documentID>/reports/<reportID>/inputcontrols | 4.1 SP3 |
Deleting an Input Control | DELETE | /documents/<documentID>/reports/<reportID>/inputcontrols/<inputControlID> | 4.1 SP3 |
Getting the Selection of an Input Control | GET | /documents/<documentID>/reports/<reportID>/inputcontrols/<inputControlID>/selection | 4.1 SP3 |
Setting the Selection of an Input Control | PUT | /documents/<documentID>/reports/<reportID>/inputcontrols/<inputControlID>/selection | 4.1 SP3 |
Deleting the Selection of an Input Control | DELETE | /documents/<documentID>/reports/<reportID>/inputcontrols/<inputControlID>/selection | 4.1 SP3 |