The REST APIs to refresh and schedule 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 | Request | Since |
---|---|---|---|
Getting the Refresh Parameters of a Document | GET | /documents/<documentID>/parameters | 4.0 SP5 | 4.1 |
Refreshing a Document | PUT | /documents/<documentID>/parameters | 4.0 SP5 | 4.1 |
Cancelling the Refresh of a Document | PUT | /documents/<documentID>/parameters/execution?cancel=<mode> | 4.0 SP6 | 4.1 |
Action | Method | URL | Since |
---|---|---|---|
Adding a Schedule | POST | /documents/<documentID>/schedules | 4.0 SP5 | 4.1 |
Getting the List of Schedules | GET | /documents/<documentID>/schedules | 4.0 SP5 | 4.1 |
Getting the Details of a Schedule | GET | /documents/<documentID>/schedules/<scheduleID> | 4.0 SP5 | 4.1 |
Deleting a Schedule | DELETE | /documents/<documentID>/schedules/<scheduleID> | 4.0 SP5 | 4.1 |