RESTful SDK for SAP BI platform

What is RESTful API?

RESTful Web Services are REST architecture based web services. In REST Architecture everything is a resource. RESTful web services are light weight, highly scalable and maintainable and are very commonly used to create APIs for web based applications.

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.

Earlier stages API / SDK contents are only supported based on your application/ software deployment. Example, if your application deployed in .Net then your SDK would only supports .Net SDK, if its deployed in Java, then it would support only Java based SDK’s. To overcome this software compatibility issues, RESTful introduced and it can connect any type of API’s and it’s common for all environments.

RESTful web services are built to work best on the Web. Representational State Transfer (REST) is an architectural style that specifies constraints, such as the uniform interface, that if applied to a web service induce desirable properties, such as performance, scalability, and modifiability, that enable services to work best on the Web. In the REST architectural style, data and functionality are considered resources and are accessed using Uniform Resource Identifiers (URIs), typically links on the Web. The resources are acted upon by using a set of simple, well-defined operations. The REST architectural style constrains an architecture to a client/server architecture and is designed to use a stateless communication protocol, typically HTTP. In the REST architecture style, clients and servers exchange representations of resources by using a standardized interface and protocol.

Here I am going to describe how RESTful SDK is helpful for BI platform perspective and what and all we can achieve using RESTful SDK in BI platform.

You can achieve almost everything from BI platform (whatever you can do from frontend – BI Launch pad) using RESTful SDK. This RESTful SDK are very much useful when you have your BI application integrated with any of your internal portal. Example, you want to show the report usage / number of reports refreshed on a daily basis on your company internal website, you can achieve those using RESTful SDK. Also you can use RESTful SDK when You want to access BI platform repository objects or perform basic scheduling, when You want to use a programming language that is not supported by other BI platform SDKs and when You do not want to download and install BI platform libraries as a part of your application.

If you want to programmatically access the advanced functionality of the BI platform, including server administration, security configuration, and modifying the repository, use one of the BI platform SDKs that support these features. For example, use the SAP Business Objects Business Intelligence platform Java SDK, the SAP Business Objects Business Intelligence platform .NET SDK, or the SAP Business Objects Business Intelligence platform Web Services SDK to access the advanced features of the BI platform.

How to use RESTful SDK in your BI platform and environment setup

• Your BI platform must have installed and configured for RESTful web services.
• You have to get the URL & port Number for your BI platform by viewing the CMC
• You should have proper login access to you BI platform.
• You should know how to build / make HTTP requests by using your preferred programming language and tools.
• Here we can see about the free google client tool Postman (

Once all the above is set you can start working on the RESTful SDK in BI Platform.

Note: In postman client, you have to select output formats which are Jason & XML and depends on the output you are selecting your input parameters / HTTP request would differ.

To know more about postman client, please click here.

To start with postman client, please get the basic BI server details below are the URL.


Then get the logon token using the below HTTP request. Add the below URL and select Method GET.


Select the Headers for Content-Type and Accept as application/json and Use the template from the GET and change the method to POST to put the response as Body.

BI platform 4.3 SDK has lot more functions and futures to provide better solution for your client. Please click here to find SAP BI document for more details.

I am here explained the very basic usage of RESTful SDK in platform and you try lot more using the available function and lots of enhancements are happening to improve the quality of RESTful SDK functions. Feel free to post your comments and I will help you to answer my level best.


Leave a Reply

Fill in your details below or click an icon to log in: Logo

You are commenting using your account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s