OData Query Options in SAP Netweaver Gateway

2
4488

Hello everyone, in this tutorial we will learn what are the different query options available in SAP Netweaver Gateway OData service.

What are Query Options ?

Query Options are parameters added to the OData service by an application to control the amount and order of data retrieved.The name of all query options will starts with “$”.

Available OData Query Options

  1. $select
  2. $count
  3. $expand
  4. $format
  5. Read $links
  6. $value
  7. $orderby
  8. $top
  9. $skip
  10. $filter
  11. $inlinecount
  12. $skiptoken

Some of the above OData query options can be used directly and some required additional implementation to be done from code perspective.Lets see what are they

OData Query Options – Implementation NOT needed

You can directly add these query options directly to the service and the service will respond accordingly.

  • $select
    • Syntax :  http://<server>:<port>/sap/opu/odata/sap/<service_name>/ProductsSet?$select=ProductId,Name,Description
  • $count
    • Syntax : http://<server>:<port>/sap/opu/odata/sap/<service_name>/ProductsSet??$count
  • $expand
    • Syntax : http://<server>:<port>/sap/opu/odata/sap/<service_name>/Suppliers?$expand=Products
  • $format
    • Syntax : http://<server>:<port>/sap/opu/odata/sap/<service_name>/ProductsSet?$format=json
  • Read $links
    • Syntax : http://<server>:<port>/sap/opu/odata/sap/<service_name>/Products(‘1001’)/$links/Category
  • $value
    • Syntax : http://<server>:<port>/sap/opu/odata/sap/<service_name>/Products(‘1000’)/Name/$value

OData Query Options – Implementation needed

You need to change the ABAP code in Data Provider Class(DPC) extension class to use these query options.

In our next tutorial we will dig deep into these OData query options one by one. Stay tuned to us for more SAP Netweaver Gateway tutorials.

Thank you. Please feel free to comment and let us know your feedback.

  • Ayyappan V

    Nice blog!!! Post more on – OData Query Options – Implementation needed