Home

SAP BusinessObjects Web Intelligence JavaScript

API Reference

These APIs make calls to the methods provided by the Web Intelligence RESTful Web Service SDK. The JSON objects used as parameters or returned by these functions provide the same data than the JSON objects or XML streams that the SDK methods can use as inputs or return. The JSON objects and XML streams are described in the SDK documentation. For more information, see the SAP BusinessObjects RESTful Web Service SDK User Guide for Web Intelligence and the BI Semantic Layer on the help portal.

What's new?

The following section provides an overview of the API changes:

SAP BusinessObjects Web Intelligence JavaScript API 4.3 SP4 (December 2023)

• New methods in WebiServices.document to manage Document Input Controls:
  • createDocumentInputControl
  • deleteDocumentInputControl
  • deleteDocumentInputControlSelection
  • getDocumentInputControl
  • getDocumentInputControlLov
  • getDocumentInputControls
  • getDocumentInputControlSelection
  • setDocumentInputControlSelection
  • updateDocumentInputControl
• New methods in WebiServices.document to manage Document Input Controls:
  • createDocumentInputControl
  • deleteDocumentInputControl
  • deleteDocumentInputControlSelection
  • getDocumentInputControl
  • getDocumentInputControlLov
  • getDocumentInputControls
  • getDocumentInputControlSelection
  • setDocumentInputControlSelection
  • updateDocumentInputControl
• New methods in WebiServices.document to get document’s objects and object’s details:
  • getDocumentDataObjects
  • getDocumentDataObject
• New events in WebiApplication to catch a save action:
  • SAVE_DOCUMENT
  • SAVE_DOCUMENT_AS
• An event bus now allows you to exchange data between extensions and custom elements using three new methods:
  • publish
  • subscribe
  • unsubscribe

SAP BusinessObjects Web Intelligence JavaScript API 4.3 SP2 (December 2021)

• OSGI mode is no more supported for extension. Extensions must be written and deployed using non-OSGI.
• Calls to Web Intelligence Java Script Mode must be asynchronous. Synchronous calls do not work anymore.
• The export methods do not return an URL anymore but directly start the resource download:
  • exportDocumentAsZip
  • exportReportAsZip
  • exportReportElement
  • exportReportElementAsImage
• The GetContext method returns new parameters:
  • isInstance: true if the document is an instance generated by a schedule
  • path: The document’s path
• Extensions and Web Intelligence JavaScript API are not yet supported in Web Intelligence Rich Client.