Skip to Content

RESTful Web Services FAQ


Introduction to REST

What is RESTful WS?

Representational State Transfer (REST) is a style of software architecture for distributed systems such as the World Wide Web.  REST has emerged as the predominant web API design model.

What are the benefits of using REST?

Some of the advantages of REST include the scalability of component interactions, generality of interfaces, and independent deployment of components. REST also acts as an intermediary between application components which can reduce latency, enforce security, and encapsulate legacy systems.

What programming languages do I use for REST WS SDK?

Since REST is language agnostic, any language that can make HTTP calls can utilize the REST API.

How secure are REST API calls?

REST for the BI platform is very secure because it generates client certificates and won’t service anyone except applications that have the corresponding private keys.

Does REST WS SDK support single sign on?

Yes, single sign on will be possible with Active Directory Authentication or Trusted Authentication.

Getting Started with the WebI REST SDK

What RESTful SDKs are available?

A REST SDK has been available for the BI Platform since 4.0.  Crystal Reports for Enterprise has supported a REST API since 4.0 FP3.  The Web Intelligence SDK with full parity with REBEAN/RENET is supported in 4.1 and later Support Packs.  SAP Lumira Cloud also supports a RESTful SDK, documented at the SAP Lumira – SAP Help Portal Page .

Where can I find the documentation ?

The Web Intelligence and Semantic Layer REST SDK documentation can be found at SAP BusinessObjects RESTful Web Service SDK User Guide for Web Intelligence and the BI Semantic Layer.  Addition documentation on the SDKs and BI Platform can be found at SAP BusinessObjects Business Intelligence platform 4.1 – SAP Help Portal Page

Are there any samples available?

Yes, samples are available at , as well as in the SCN community site for the REST SDK listed below.

Is there an SCN space for the REST SDK?

Yes, at

Upgrading from 3.1 to 4.1

I am using version 3.1 and I want to upgrade to 4.1. What should I know?

Starting in 4.0, SAP has been focusing on the REST paradigm for new SDKs.  The BI Platform, Crystal Reports, and Web Intelligence SDKs all have REST APIs.  The BI platform SDK supports user authentication; the Crystal Reports SDK supports report consumption; and finally, the Web Intelligence SDK replaces the Report Engine SDKs and supports report consumption and modification.

How does Web Intelligence RESTful WS SDK work and how is it different than REBean?

The previous 3.1 Web Intelligence SDKs provided APIs in two languages, Java and .NET.  The new RESTful Web Services SDK for Web intelligence replaces these older SDKs and and provides functional parity in 4.1 and later releases.

How do I change data providers?  Will the REST SDK allow me to convert UNV to UNX?

The Web Intelligence REST SDK allows you to change data providers for a Web intelligence document through its API.  A sample can be found at

How do I activate REST WS SDK on my BI platform?

REST is activated by default when you install the BI platform.  Be sure to check the REST WS option during the installation.

Former Member