Document URLs

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

The URL must be used with the default base URL value: <webiURL>.

Action Method URL
Alerters: add a new alerter to a document POST /documents/{documentId}/alerters
Alerters: delete an alerter DELETE /document/{documentId}/alerters/{alerterId}
Alerters: get the full description of an alerter GET /document/{documentId}/alerters/{alerterId}
Alerters: get the list of all alerters defined in a document GET /documents/{documentId}/alerters
Alerters: update the description of an alerter PUT /document/{documentId}/alerters/{alerterId}
Attachments: add an attachment to a document POST /documents/{documentId}/attachments/
Attachments: get the list of attachments to a document GET /documents/{documentId}/attachments/
Cache: add a cache entry POST /documents/{documentId}/cache
Charsets: get the charsets supported on a Web Intelligence Server GET /configuration/charsets
Charts: get the list of all available char types GET /configuration/visualizations
Color palettes: get the list of default color palettes GET /configuration/palettes
Copy a document POST /documents
Create an empty document POST /documents
CSS: get the CSS of a document GET /documents/{documentId}/css
CSS: update the CSS of a document PUT /documents/{documentId}/css
Custom format numbers: get a list of the custom format numbers defined in a document GET /documents/{documentId}/formats
Delete a document DELETE /documents/{documentId}
Document details: get the details of a document GET /documents/{documentId}
Document list: retrieve the document list from the CMS GET /documents
Document properties: get the document properties GET /documents/{documentId}/properties
Document properties: update the document properties PUT /documents/{documentId}/properties
Document list: retrieve the document list from the CMS GET /documents
Export a document GET /documents/{documentId}
Export a document as pages GET

/documents/{documentId}/pages

Formats: get a list of all declared formats on the Web Intelligence server for the default locale GET /configuration/formats
Font mappings: get a list of all declared font mappings on a Web Intelligence server GET /configuration/fontmappings
Functions: get all of the available functions of the formula engine GET /configuration/functions
Links: add a new link to the documents expressions dictionary POST /documents/{documentId}/links
Links: get the content of a document link dictionary GET /documents/{documentId}/links
Links: get the description of a link of a document GET /documents/{documentId}/links/{linkId}
Links: modify a link of a document PUT /documents/{documentId}/links/{linkId}
Links: remove a link from the document DELETE /documents/{documentId}/links/{linkId}
List of values: get the list of values of a data object GET /documents/{documentId}/dataobjects/{dataObjectId}/lov
List of values: get the list of values under a specific data object value PUT /documents/{documentId}/dataobjects/{dataObjectId}/lov
Operators: get all of the available operators of the formula engine GET /configuration/operators
Skins: get a list of all declared skins on a Web Intelligence server GET /configuration/skins
Styles: get the list of all defined styles in a document GET /documents/{documentId}/styles
Styles: add a new style to a document POST /documents/{documentId}/styles
Styles: delete a style definition DELETE /documents/{documentId}/styles/{styleId}
Styles: get the detailed description of a style GET /documents/{documentId}/styles/{styleId}
Styles: update a style definition PUT /documents/{documentId}/styles/{styleId}
Track changes: get the current trackdata definition for a document GET /documents/{documentId}/tracker
Track changes enable the tracker resource POST /documents/{documentId}/tracker
Track changes: disable the tracker resource DELETE /documents/tracker
Track changes: change the track data information PUT /documents/{documentId}/tracker
Update a document (close/save) PUT /documents/{documentId}
Variables: get the content of a document variable dictionary GET /documents/{documentId}/variables
Variables: add a new expression to a document variable dictionary POST /documents/{documentId}/variables
Variables: delete a variable from a document variable dictionary DELETE /documents/{documentId}/variables/{variableId}
Variables: get the definition of a variable from a document variable dictionary GET /documents/{documentId}/variables/{variableId}
Variables: modify the definition of a variable from a document variable dictionary PUT /documents/{documentId}/variables/{variableId}
ZIP: create a ZIP file from a document POST /documents/{documentId}/zips?reportIds={reportId[,...]}
ZIP: get a document as a ZIP file GET /documents/{documentId}/zips/{zipId}
ZIP: delete a ZIP file DELETE /documents/{documentId}/zips/{zipId}