The REST APIs to work with queries in reports.
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 |
---|---|---|---|
Getting the List of Data Providers | GET | /documents/<documentID>/dataproviders | 4.0 SP5 | 4.1 |
Getting the Details of a Data Provider | GET | /documents/<documentID>/dataproviders/<dataProviderID> | 4.0 SP5 | 4.1 |
Adding a Data Provider | POST | /documents/<documentID>/dataproviders | 4.0 SP6 | 4.1 |
Moving a Data Provider in a Document | PUT | /documents/<documentID>/dataproviders?fromId=<DPn>&toId=<DPx> | 4.0 SP6 | 4.1 |
Updating a Data Provider | PUT | /documents/<documentID>/dataproviders/<dataProviderID> | 4.0 SP5 | 4.1 |
Deleting a Data Provider | DELETE | /documents/<documentID>/dataproviders/<dataProviderID> | 4.0 SP6 | 4.1 |
Getting the Flow Count of a Data Provider | GET | /documents/<documentID>/dataproviders/<dataProviderID>/flows/count | 4.0 SP5 | 4.1 |
Getting the Details of a Flow | GET | /documents/<documentID>/dataproviders/<dataProviderID>/flows/<flowID> | 4.0 SP5 | 4.1 |
Getting the Samples of a Flow | GET | /documents/<documentID>/dataproviders/<dataProviderID>/flows/<flowID>/samples | 4.1 SP5 |
Getting the Query Plan | GET | /documents/<documentID>/dataproviders/<dataProviderID>/queryplan | 4.1 SP4 |
Updating the Query Plan | PUT | /documents/<documentID>/dataproviders/<dataProviderID>/queryplan | 4.1 SP4 |
Getting the Query Specification | GET | /documents/<documentID>/dataproviders/<dataProviderID>/specification | 4.0 SP6 | 4.1 |
Updating the Query Specification | PUT | /documents/<documentID>/dataproviders/<dataProviderID>/specification | 4.0 SP6 | 4.1 |
Action | Method | URL | Since |
---|---|---|---|
Uploading an Excel Spreasheet to the CMS Repository | POST | /spreadsheets | 4.1 SP5 |
Getting the List of Excel Spreadsheets | GET | /spreadsheets | 4.1 SP5 |
Getting the Details of an Excel Spreadsheet | GET | /spreadsheets/<spreadsheetID> | 4.1 SP5 |
Deleting an Excel Spreadsheet | DELETE | /spreadsheets/<spreadsheetID> | 4.1 SP6 |
Action | Method | URL | Since |
---|---|---|---|
Getting the List of Connections | GET | /connections | 4.1 SP5 |
Getting the Details of a Connection | GET | /connections/<connectionID> | 4.1 SP5 |
Action | Method | URL | Since |
---|---|---|---|
Getting the Possible Object Mappings Using the Default Strategies | GET | /documents/<documentID>/dataproviders/<dataProviderID>/mappings?originDataproviderIds=<DP1ID>,<DP2ID>&targetDatasourceId=<DatasourceID> | 4.0 SP6 | 4.1 |
Getting the Possible Object Mappings Using Selected Strategies |
PUT |
/documents/<documentID>/dataproviders/<dataProviderID>/mappings?originDataproviderIds=<DP1ID>,<DP2ID>&targetDatasourceId=<DatasourceID> |
4.1 SP6 |
Changing the Data Objects of a Data Provider | POST | /documents/<documentID>/dataproviders/<dataProviderID>/mappings?originDataproviderIds=<DP1ID>,<DP2ID>&targetDatasourceId=<DatasourceID> | 4.0 SP6 | 4.1 |
Action | Method | URL | Since |
---|---|---|---|
Getting the Refresh Parameters of a Data Provider | GET | /documents/<documentID>/dataproviders/<dataProviderID>/parameters | 4.1 SP5 |
Refreshing a Data Provider | PUT | /documents/<documentID>/dataproviders/<dataProviderID>/parameters | 4.1 SP5 |