The REST APIs to work with the elements of a report.
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 Element | POST | /documents/<documentID>/reports/<reportID>/elements | 4.1 SP2 |
Getting the List of Report Elements | GET | /documents/<documentID>/reports/<reportID>/elements | 4.0 SP6 | 4.1 |
Getting the Details of a Report Element | GET | /documents/<documentID>/reports/<reportID>/elements/<elementID> | 4.0 SP6 | 4.1 |
Inserting a Row or Column into a Table | POST | /documents/<documentID>/reports/<reportID>/elements/<elementID>?strip=<strip>&position=<position> | 4.1 SP6 |
Merging or Splitting Cells of a Table | PUT | /documents/<documentID>/reports/<reportID>/elements/<elementID>?operation=<operation>&targetCellIds=<CellID[,...]> | 4.1 SP6 |
Getting the Background of a Report Element | GET | /documents/<documentID>/reports/<reportID>/elements/<elementID>/background | 4.1 SP5 |
Getting the Datapaths of a Report Element | GET | /documents/<documentID>/reports/<reportID>/elements/<elementID>/datapaths | 4.1 SP3 |
Getting the Dataset of a Report Element | GET | /documents/<documentID>/reports/<reportID>/elements/<elementID>/dataset | 4.1 SP3 |
Exporting a Report Element | GET | /documents/<documentID>/reports/<reportID>/elements/<elementID> | 4.0 SP6 | 4.1 |
Updating a Report Element | PUT | /documents/<documentID>/reports/<reportID>/elements/<elementID> | 4.1 SP2 |
Deleting a Report Element | DELETE | /documents/<documentID>/reports/<reportID>/elements/<elementID> | 4.1 SP2 |
Action | Method | URL | Since |
---|---|---|---|
Getting the List of Custom Properties | GET | /documents/<documentID>/reports/<reportID>/elements/<elementID>/properties | 4.1 SP3 |
Getting the Custom Property Value | GET | /documents/<documentID>/reports/<reportID>/elements/<elementID>/properties/<propertyKey> | 4.1 SP3 |
Adding a Custom Property to a Report Element | POST | /documents/<documentID>/reports/<reportID>/elements/<elementID>/properties | 4.1 SP3 |
Updating a Custom Property | PUT | /documents/<documentID>/reports/<reportID>/elements/<elementID>/properties | 4.1 SP3 |
Deleting a Custom Property | DELETE | /documents/<documentID>/reports/<reportID>/elements/<elementID>/properties/<propertyKey> | 4.1 SP3 |
Action | Method | URL | Since |
---|---|---|---|
Creating a Data Filter for a Report Element | POST | /documents/<documentID>/reports/<reportID>/elements/<elementID>/datafilter | 4.1 SP2 |
Getting the Details of a Data Filter for a Report Element | GET | /documents/<documentID>/reports/<reportID>/elements/<elementID>/datafilter | 4.1 SP2 |
Updating the Data Filter for a Report Element | PUT | /documents/<documentID>/reports/<reportID>/elements/<elementID>/datafilter | 4.1 SP2 |
Deleting a Data Filter from a Report Element | DELETE | /documents/<documentID>/reports/<reportID>/elements/<elementID>/datafilter | 4.1 SP2 |
Action | Method | URL | Since |
---|---|---|---|
Creating a Ranking in a Report Element | POST | /documents/<documentID>/reports/<reportID>/elements/<elementID>/ranking | 4.1 SP3 |
Updating the Ranking of a Report Element | PUT | /documents/<documentID>/reports/<reportID>/elements/<elementID>/ranking | 4.1 SP3 |
Deleting the Ranking of a Report Element | DELETE | /documents/<documentID>/reports/<reportID>/elements/<elementID>/ranking | 4.1 SP3 |
Action | Method | URL | Since |
---|---|---|---|
Updating the Expressions of an Axis | PUT | /documents/<documentID>/reports/<reportID>/elements/<elementID>/axes/<axisID>/expressions | 4.1 SP3 |
Removing the Expressions From an Axis | DELETE | /documents/<documentID>/reports/<reportID>/elements/<elementID>/axes/<axisID>/expressions | 4.1 SP3 |
Action | Method | URL | Since |
---|---|---|---|
Updating the Sortings of an Axis | PUT | /documents/<documentID>/reports/<reportID>/elements/<elementID>/axes/<axisID>/sorts | 4.1 SP3 |
Removing the Sortings From an Axis | DELETE | /documents/<documentID>/reports/<reportID>/elements/<elementID>/axes/<axisID>/sorts | 4.1 SP3 |
Creating a Table Break | POST | /documents/<documentID>/reports/<reportID>/elements/<elementID>/axes/<axisID>/breaks | 4.1 SP3 |
Updating a Table Break | PUT | /documents/<documentID>/reports/<reportID>/elements/<elementID>/axes/<axisID>/breaks/<breakID> | 4.1 SP3 |
Deleting a Table Break | DELETE | /documents/<documentID>/reports/<reportID>/elements/<elementID>/axes/<axisID>/breaks/<breakID> | 4.1 SP3 |