Document URLs

This is a reference to the URLs available to manage Web Intelligence documents.

In the table below are indicated the 4.0 and/or 4.1 releases from which each call is supported. The URL must be used with the default base URL value: <webiURL>.

Action Method URL Release
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 1: Alerters
Action Method URL Release
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 2: Document Information
Action Method URL Release
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 3: Links
Action Method URL Release
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 4: Custom Palettes
Action Method URL Release
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 5: Styles
Action Method URL Release
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 6: Trackers
Action Method URL Release
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/tracker 4.0 SP6 | 4.1
Table 7: Variables
Action Method URL Release
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 8: ZIP Files
Action Method URL Release
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