Document APIs

The REST APIs to manage 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:

  • <documentID>: document identifier retrieved from the list of documents
  • <dataObjectID>: data object identifier retrieved from the definition of the input control to which the data object is assigned
  • <alerterID>: alerter identifier retrieved from the list of alerters
  • <inputControlID>: input control identifier retrieved from the list of input controls
  • <linkID>: link identifier retrieved from the list of links
  • <paletteID>: custom palette identifier retrieved from the list of palettes
  • <styleID>: style identifier from the list of styles of the document
  • <variableID>: variable identifier retrieved from the list of variables of the document
  • <zipID>: ZIP file identifier obtained by creating the zip file

Query parameters: see the detailed description of the related API.

Table 1: Documents
Action Method URL Since
Creating a Document POST /documents 4.0 SP6 | 4.1
Copying a Document POST /documents 4.0 SP6 | 4.1
Getting the List of Documents GET /documents 4.0 SP5 | 4.1
Getting the Details of a Document GET /documents/<documentID> 4.0 SP5 | 4.1
Saving a Document POST /documents/<documentID> 4.1 SP4
Deleting a Document DELETE /documents/<documentID> 4.0 SP6 | 4.1
Exporting a Document in Listing Mode GET /documents/<documentID> 4.0 SP5 | 4.1
Exporting a Document as a Series of Pages GET /documents/<documentID>/pages 4.0 SP5 | 4.1
Adding an Attachment POST /documents/<documentID>/attachments 4.0 SP6 | 4.1
Getting the List of Attachments GET /documents/<documentID>/attachments 4.0 SP6 | 4.1
Adding a Cache Entry to a Document POST /documents/<documentID>/cache 4.0 SP6 | 4.1
Getting the CSS of a Document GET /documents/<documentID>/css 4.0 SP6 | 4.1
Updating the CSS of a Document PUT /documents/<documentID>/css 4.0 SP6 | 4.1
Getting the List of Values of a Data Object GET /documents/<documentID>/dataobjects/<dataObjectID>/lov 4.1 SP3
Getting the List of Values Under a Specific Data Object Value PUT /documents/<documentID>/dataobjects/<dataObjectID>/lov 4.1 SP3
Getting Custom Formats for Numbers GET /documents/<documentID>/formats 4.0 SP6 | 4.1
Getting the Properties of a Document GET /documents/<documentID>/properties 4.0 SP6 | 4.1
Updating the Properties of a Document PUT /documents/<documentID>/properties 4.0 SP6 | 4.1
Table 2: Alerters
Action Method URL Since
Adding an Alerter POST /documents/<documentID>/alerters 4.0 SP6 | 4.1
Getting the List of Alerters GET /documents/<documentID>/alerters 4.0 SP6 | 4.1
Getting the Details of an Alerter GET /document/<documentID>/alerters/<alerterID> 4.0 SP6 | 4.1
Editing an Alerter PUT /document/<documentID>/alerters/<alerterID> 4.0 SP6 | 4.1
Deleting an Alerter DELETE /document/<documentID>/alerters/<alerterID> 4.0 SP6 | 4.1
Table 3: Document Information
Action Method URL Since
Getting the Charsets GET /configuration/charsets 4.0 SP6 | 4.1
Getting the Chart Types GET /configuration/visualizations 4.1 SP1
Getting the Default Color Palettes GET /configuration/palettes 4.1 SP1
Getting the Configuration Formats GET /configuration/formats 4.0 SP6 | 4.1
Getting the Font Mappings GET /configuration/fontmappings 4.0 SP6 | 4.1
Getting the Formula Engine Functions GET /configuration/functions 4.0 SP6 | 4.1
Getting the Formula Engine Operators GET /configuration/operators 4.0 SP6 | 4.1
Getting the Report Skins GET /configuration/skins 4.0 SP6 | 4.1
Table 4: Document Input Controls
Action Method URL Since
Getting the Input Controls of a Document GET /documents/<documentID>/inputcontrols 4.1 SP6
Moving an Input Control from a Report to a Document PUT /documents/<documentID>/inputcontrols?fromId=<fromID> 4.1 SP6
Getting the Definition of a Document Input Control GET /documents/<documentID>/inputcontrols/<inputControlID> 4.1 SP6
Updating the Definition of a Document Input Control PUT /documents/<documentID>/inputcontrols/<inputControlID> 4.1 SP6
Adding an Input Control to a Document POST /documents/<documentID>/inputcontrols 4.1 SP6
Deleting a Document Input Control DELETE /documents/<documentID>/inputcontrols/<inputControlID> 4.1 SP6
Getting the Selection of a Document Input Control GET /documents/<documentID>/inputcontrols/<inputControlID>/selection 4.1 SP6
Setting the Selection of a Document Input Control PUT /documents/<documentID>/inputcontrols/<inputControlID>/selection 4.1 SP6
Deleting the Selection of a Document Input Control DELETE /documents/<documentID>/inputcontrols/<inputControlID>/selection 4.1 SP6
Table 5: Links
Action Method URL Since
Adding a Link POST /documents/<documentID>/links 4.0 SP6 | 4.1
Getting the Links of a Document GET /documents/<documentID>/links 4.0 SP6 | 4.1
Getting the Details of a Link GET /documents/<documentID>/links/<linkID> 4.0 SP6 | 4.1
Editing a Link PUT /documents/<documentID>/links/<linkID> 4.0 SP6 | 4.1
Deleting a Link DELETE /documents/<documentID>/links/<linkID> 4.0 SP6 | 4.1
Table 6: Custom Palettes
Action Method URL Since
Creating a Custom Palette POST /documents/<documentID>/palettes 4.1 SP5
Getting the List of Custom Palettes GET /documents/<documentID>/palettes 4.1 SP5
Getting the Details of a Custom Palette GET /documents/<documentID>/palettes/<paletteID> 4.1 SP5
Updating the Definition of a Custom Palette PUT /documents/<documentID>/palettes/<paletteID> 4.1 SP5
Deleting a Custom Palette DELETE /documents/<documentID>/palettes/<paletteID> 4.1 SP5
Table 7: Styles
Action Method URL Since
Getting the Styles of a Document GET /documents/<documentID>/styles 4.0 SP6 | 4.1
Adding a Style to a Document POST /documents/<documentID>/styles 4.0 SP6 | 4.1
Getting the Details of a Style GET /documents/<documentID>/styles/<styleID> 4.0 SP6 | 4.1
Updating a Style PUT /documents/<documentID>/styles/<styleID> 4.0 SP6 | 4.1
Deleting a Style DELETE /documents/<documentID>/styles/<styleID> 4.0 SP6 | 4.1
Table 8: Trackers
Action Method URL Since
Getting the Tracker Settings GET /documents/<documentID>/tracker 4.0 SP6 | 4.1
Creating the Tracker Settings POST /documents/<documentID>/tracker 4.0 SP6 | 4.1
Editing the Tracker Settings PUT /documents/<documentID>/tracker 4.0 SP6 | 4.1
Deleting the Tracker Settings DELETE /documents/<documentID>/tracker 4.0 SP6 | 4.1
Table 9: Variables
Action Method URL Since
Getting the Variables of a Document GET /documents/<documentID>/variables 4.0 SP6 | 4.1
Adding a Variable POST /documents/<documentID>/variables 4.0 SP6 | 4.1
Getting the Definition of a Variable GET /documents/<documentID>/variables/<variableID> 4.0 SP6 | 4.1
Editing a Variable PUT /documents/<documentID>/variables/<variableID> 4.0 SP6 | 4.1
Deleting a Variable DELETE /documents/<documentID>/variables/<variableID> 4.0 SP6 | 4.1
Table 10: ZIP Files
Action Method URL Since
Creating a ZIP File from a Document POST /documents/<documentID>/zips?reportIds=<reportID>[,...] 4.1 SP3
Getting a Document as a ZIP file GET /documents/<documentID>/zips/<zipID> 4.1 SP3
Deleting a ZIP File DELETE /documents/<documentID>/zips/<zipID> 4.1 SP3