Skip to content

Read Records with $top and $skip Options

To demonstrate how to send a simple GET request and obtain the corresponding response, the BusinessLeadHandling projection is used here.

Before you Begin
  1. Obtain the access token by following the steps given in the Authentication page.
  2. Make sure the user you used while obtaining the access token, has the permission set granted to access the BusinessLeadHandling projection used in the quick start. To do this, first, let's create a permission set.
    1. Navigate to Solution Manager > Users and Permissions > Permission Sets.
    2. Click on the + icon and create a new permission set as shown below. create_permission_set
    3. Tick the checkbox corresponding to the newly created permission set and click Details.
    4. Select Projections from the left navigation.
    5. In the Granted Projections panel, click Add/Revoke and select Add from the dropdown that appears.
    6. Filter by the projection name, BusinessLeadHandling.
    7. Tick the checkbox and click OK.
      8. add_projection_to_set
    The required projection will be added to the permission set as shown above. Now let us add the user to this permission set.
    1. Select Users Granted from the left navigation.
    2. In the Users Granted panel, click Add Users.
    3. Filter using the same user name you used while you created the client for the authentication process
      4. .
    4. Click OK.
      5. users_granted

In IFS Cloud

  1. Navigate to Solution Manager > Integration > API Explorer. Alternatively, search for API Explorerin the search bar.

  2. Filter by API Name, BusinessLeadHandling.

  3. Navigate to the API Documentation as shown below. simple_get_apidoc

  4. In the API documentation, select BusinessLeads on the left navigation and click on Get entities from BusinessLeads.

  5. Copy the URL provided in the right panel.

simple_apidoc_page

In Postman

Simple GET Request

  1. Open a new GET request and paste the URL you copied from the API Doc in the previous step as the Request URL.

  2. Make sure that the header tab has an Authorization key with the value in the format of Bearer <access token> as shown below. This is the access token you obtained while authenticating the request.

postman_simple_get

  1. Click Send

You will now see the entities listed in the response.

get_req_response

GET Request with $top Option

The $top query option is used when only a certain number of records are required to be listed. This enables efficiently handling the amount of data retrieved from the server.

Let us assume that only a limited number of records are required from the entity list obtained in the response above.

Modify the simple request URL above by adding ?$top=1. On pressing send, the response will only contain the first record.

postman_stop

GET Request with $skip Option

The $skip query option is used when a number of records need to be skipped from the response obtained.

Let us assume that the first three records in the entity list are not required to be displayed.

Modify the simple request URL above by adding ?skip=3. On pressing send, the response skip the first three records and display starting from the fourth record.

postman_skip

Combining $top and $skip Options

Multiple query options can also be used for the same request URL.

Below is an example where the response will skip the first three records and then stop displaying after the next two records. That is, only the fourth and fifth records will be obtained in the response.

stop_skip_response