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

REST SDK APIs URL : http://<host>:<port>/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://<base-url>/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://<base-url>/categories/cuid).
  • For the existing APIs, ‘cuid’ as well as ‘cuid_<cuid>’ will be supported.( For example: http://<base-url>/infostore/cuid as well as http://<base-url>/infostore/cuid_<cuid> will be supported )).

 

Query Parameters Details:

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

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.

attribute_name=value

Example for filters:

type=folder

owner=bharath

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.)

 

To report this post you need to login first.

Be the first to leave a comment

You must be Logged on to comment or reply to a post.

Leave a Reply