Get Even More Visitors To Your Blog, Upgrade To A Business Listing >>

BI Platform REST SDK version1

Introduced version1 of REST SDK from SAP BOE 4.2SP03 and onwards.

REST SDK APIs URL : http://:/biprws/v1

URI standards :

  • Uniformity with all the existing APIs
  • case : lowercase
  • no verbs in API URL.
  • Context basis URIs

Request/Response :

  • Attributes in Response body in lower case.
  • In Response body, feed links must just give link +pagination link. No sorting/filtering query parameter should be provided there.
  •  Support Multi-model if required.
  • For all the listing APIs, attributes will be basic information( id, cuid, name, type, updated ) + additional  attributes related to the context.
  • Avoid using ‘feed’ tag in case of single entry in response.

Query Parameters :

  • Filtering,Pagination and sorting for all APIs. Other filters will be context specific .
  • For sorting, query Parameter is “sort”. And order of sorting will be decided by ‘-‘ (For example : sort=-title(descending), sort=title(ascending)).
  • Support sorting on multiple attributes, follow left to right convention.
  • Support sorting just on attributes present in the Response Body.
  • Support filtering the attributes of Response body by query parameter “field” ( For example: http:///categories?field=title,parentid -> will result back all categories with title and parentid attributes).
  • Support filter on name “like %”.

SI_ID / CUID Support :

  • Support CUID for  all the new APIs ( for example : http:///categories/cuid).
  • For the existing APIs, ‘cuid’ as well as ‘cuid_’ will be supported.( For example: http:///infostore/cuid as well as http:///infostore/cuid_ will be supported )).

Query Parameters Details:

Query Parameters Description
page page number
pagesize number of objects in each page

sort=+attribute_name(or sort=attribute_name) for ascending order .

sort=-attribute_name for descending order.

If ‘sort’ filter is not provided, by default the Sorting is on SI_NAME ascending order.


Example for filters:



created=2015-11-16T11:03:53.727Z , 2016-11-16T11:03:53.727Z

updated=2015-11-16T11:03:53.727Z , 2016-11-16T11:03:53.727Z

(if second date is null, default till date() will be the value.)

This post first appeared on Web Service Testing A Blackjack GUI And API, please read the originial post: here

Share the post

BI Platform REST SDK version1


Subscribe to Web Service Testing A Blackjack Gui And Api

Get updates delivered right to your inbox!

Thank you for your subscription