Exploring Various Data Retrieval Options Using GET request

In this video, you’ll learn various retrieval options in SAP Business One using Service Layer.

In this exercise, you’ll practice retrieving data in the Service Layer API using different query options.

Before starting this exercise, make sure that you:

• Install a REST API client tool, such as Postman.
• Download the Demo UK International database from SAP Business One Localized Demo Databases
• Complete a login request so that you have a session ready to use.

1. To retrieve a sales order collection, amend the following HTTP sample request and send:

Sample request

Code Snippet

Copy codeSwitch to dark mode

1
GET https://localhost:50000/b1s/v2/Orders

2. Check the response:

   1. Check the response code - it should be 200 OK if the HTTP request is successful.

   2. Check the response content - it should contain the list of sales orders with all the properties starting from the first 20 documents. (20 documents are retrieved based on the Pagesize set in the Service Layer Configuration).

   3. At the end of the response content is the property, odata.nextLink, which provides the link for the next collection chunk.

3. To retrieve specific sales order with all property, amend the following HTTP sample request and send:

Sample request

Code Snippet

Copy codeSwitch to dark mode

1
GET https://localhost:50000/b1s/v2/Orders(10)

4. Check the response:

   1. Check the response code - it should be 200 OK if the HTTP request is successful.

   2. Check the response content - it should contain all the properties for the sales order docentry mentioned in the request.

5. To retrieve individual property for a sales order, amend the following HTTP sample request and send:

Sample request

Code Snippet

Copy codeSwitch to dark mode

1
GET https://localhost:50000/b1s/v2/Orders(10)/DocNum

6. Check the response:

   1. Check the response code - it should be 200 OK if the HTTP request is successful.

   2. Check the response content - it should contain only the DocNum property along with the @odata.context and @odata.etag.

7. To retrieve individual property value for a sales order, amend the following HTTP sample request and send:

Sample request

Code Snippet

Copy codeSwitch to dark mode

1
GET https://localhost:50000/b1s/v2/Orders(10)/DocNum/$value

8. Check the response:

   1. Check the response code - it should be 200 OK if the HTTP request is successful.

   2. Check the response content - it should contain only the value of DocNum.

9. To retrieve the list of the delivery note associated with the Business Partner for a particular sales order, amend the following HTTP sample request and send:

Sample request

Code Snippet

Copy codeSwitch to dark mode

1
GET https://localhost:50000/b1s/v2/Orders(10)/BusinessPartner/DeliveryNotes

10. Check the response:

    1. Check the response code - it should be 200 OK if the HTTP request is successful.

    2. Check the response content - it should contain the first 20 delivery notes associated with the Business Partner used in the sales order. (20 documents are retrieved based on the Pagesize set in the Service Layer Configuration).

    3. At the end of the response content, there is the property odata.nextLink, which provides the link for the next collection chunk.

11. To retrieve the sales order collection only with three properties DocNum,DocDueDate,DocTotal using query options, amend the following HTTP sample request and send:

Sample request

Code Snippet

Copy codeSwitch to dark mode

1
GET https://localhost:50000/b1s/v2/Orders/?$select=DocNum,DocDate,DocTotal

12. Check the response:

    1. Check the response code - it should be 200 OK if the HTTP request is successful.

    2. Check the response content - it should contain the first 20 sales orders with properties: DocNum,DocDate,DocTotal. (20 documents are retrieved based on the Pagesize set in the Service Layer Configuration).

    3. At the end of the response content is the property, odata.nextLink, which provides the link for the next collection chunk.

13. To retrieve the sales order collection only with three properties (DocNum,DocDate,Doctotal), and filter the document based on DocDate using query options, amend the following HTTP sample request and send:

Sample request

Code Snippet

Copy codeSwitch to dark mode

1
GET https://localhost:50000/b1s/v2/Orders$filter=DocDate ge '2020-03-23'& $select=DocNum,DocDueDate,DocTotal 

14. Check the response:

    1. Check the response code - it should be 200 OK if the HTTP request is successful.

    2. Check the response content - it should contain the first 20 sales orders with properties: DocNum,DocDate,DocTotal. (20 documents are retrieved based on the Pagesize set in the Service Layer Configuration).

    3. At the end of the response content is the property, odata.nextLink, which provides the link for the next collection chunk.

15. To retrieve the count of sales order in the database using query options, amend the following HTTP sample request and send:

Sample request

Code Snippet

Copy codeSwitch to dark mode

1
GET https://localhost:50000/b1s/v2/Orders?$apply=aggregate($count as OrdersCount)

16. Check the response:

    1. Check the response code - it should be 200 OK if the HTTP request is successful.

    2. Check the response content - it should contain the count value under the property name OrdersCount.

17. To retrieve the list of sales orders grouped by CardCode and DocTotal using query options, amend the following HTTP sample request and send:

Sample request

Code Snippet

Copy codeSwitch to dark mode

1
GET https://localhost:50000/b1s/v2/Orders?$apply=groupby((CardCode), aggregate(DocTotal with sum as Total))

18. Check the response:

    1. Check the response code - it should be 200 OK if the HTTP request is successful.

    2. Check the response content - it should contain the list of CardCode with sum of the DocTotal value..

19. To retrieve the associated business partner information from the sales order in the same payload, amend the following HTTP sample request and send:

Sample request

Code Snippet

Copy codeSwitch to dark mode

1
GET https://localhost:50000/b1s/v2/Orders(10)?$select=*,BusinessPartner&$expand=BusinessPartner

20. Check the response:

    1. Check the response code - it should be 200 OK if the HTTP request is successful.

    2. Check the response content - After the "@odata.etag" property the BusinessPartner entity information is displayed followed by the sales order properties.