SharePoint Rest API Select, Filter, Sort and Paging Example
Check out Best Alternative to InfoPath -> Try Now
This SharePoint Rest API tutorial, we will discuss how to use Rest API select, filter, sort and paging in the SharePoint list. The same way we can use SharePoint Rest API select, filter, sort and paging in SharePoint Online or SharePoint 2013/2016.
I have explained how to work with SharePoint list items, basically performing CRUD operations, using the combination of REST API and jQuery Ajax. You can check out CRUD operations in SharePoint 2013 list item using rest api.
The REST URI ends with any OData query operators to specify selecting, sorting, or filtering. Let’s see other parameters and options which can be used with REST services. We will start from the basic REST URL and will take Selecting, filtering, sorting and pagination options one by one.
The main agenda of this tutorial is to understand how you can use take Selecting, filtering, sorting and pagination options one by one using SharePoint 2013 list.
There can be scenarios where you want to perform additional operations on data returned by REST API like Selecting, filtering, sorting and pagination fields only, etc. For such operations while forming Url to Get data, we have to add some parameters as described below:-
SharePoint 2016 Tutorial Contents
Rest API Select and sort list item example
The above URL returns all items with all possible fields or list columns.
But what if the list has more than 20-30 columns? It’s not good practice to get all the fields. Get only a specific field that is required. You can select the specific attributes to return for your items using the $select parameter. Below example shows how to use it
Syntax for this is $select=Field1, Field2, Field3 /_api/web/lists/getbytitle('infolist')/items?$select=ID,Title,Employee,company
‘$orderby’: If your response is a list of items, each with a number of field names, you can sort the list on a given field name using the $orderby, $orderby.asc or $orderby.desc system filter parameter.
The first two specify sorting in ascending order and the third one descending order. Simple, you can use ‘$orderby’ parameter and provide the field name. REST service will return sorted list items in response.
Syntax: for this is $orderby=(Column Internal Name order)
See below examples-
Below is the Rest API syntax for sharepoint rest api sort ascending.
Ascending Order: /_api/web/lists/getbytitle('infolist')/items?$select=ID,Title,Employee,company&$orderby= Employee asc
Below is the Rest API syntax for sharepoint rest api sort descending.
Descending Order: /_api/web/lists/getbytitle('infolist')/items?$select=ID,Title,Employee,company&$orderby= Employee desc
Filtering items: You can filter your list to contain only items which match a simple logical expression using the $filter parameter.
Syntax: for this is $filter=(Column Internal Name operator value).
See below examples-
|Filter by Title||/_api/web/lists/getbytitle(‘infolist’)/items?$filter= Employee eq ‘parth’|
|Filter by ID:||/_api/web/lists/getbytitle(‘infolist’)/items?$filter=ID eq 2|
|Filter by Date||/_api/web/lists/getbytitle(‘infolist’)/items?$filter=Start_x0020_Date le datetime’2016-03-26T09:59:32Z’|
|Multiple Filters||/_api/web/lists/getbytitle(‘infolist’)/items?$filter=( Modified le datetime’2016-03-26T09:59:32Z’) and (ID eq 2)|
|Title name starts with the letter P||/_api/web/lists/getbytitle(‘’infolist’)/items?$filter=startswith(Title,‘P’)|
|Return all items from the ‘infolist’list modified in May||/_api/web/lists/getbytitle(‘’infolist’)/items? $filter=month(Modified) eq 5|
OData query operators supported in the SharePoint REST service
|Arithmetic operators (Add, Sub, Mul, Div, Mod)|
Basic math functions (round, floor, ceiling)
|Date and time functions|
Querying as to whether a datetime falls inside a recurrent datetime pattern
Paging items: The $top operators are used to implement paging for results. The $top operator specifies how many results to return.
Syntax for this is $top Count. This returns top n records.
See below example:
Note: The $skip operator does not work in SharePoint 2013 on list items.it works only on Lists.
See below example
/_api/web/lists? Orderby Title desc&$skip
$expand: This is very useful when dealing with a person or lookup fields where the only Id is returned. Using this we can get corresponding value based on Id.
See below example:
Lookup Field: Say there is City column in County list which is a lookup to Title column in Info List.
People Field: let’s say list have the custom field: Author, it will return ‘AuthorId’ in response.
What is the proper way to deal with people fields? You need to use the ‘$expand’ parameter to expand the field.
Following the REST URL gives your idea of how to use $expand.
You may like following SharePoint Rest API tutorials:
- Display Task List data in a table using SharePoint REST API and filter by status column
- Create Highcharts in SharePoint using Rest API
- Create a Custom Calendar in SharePoint using Rest API and jQuery
- Retrieve and Display TASK status using REST API in SharePoint
- Update People Picker Group field using Rest API and jQuery in SharePoint 2013/2016
- SharePoint 2016 crud operations using Rest API and jQuery on list or document library
- How to Trigger Sharepoint 2013 Designer workflow on a list item by calling REST API using jQuery?
- Upload attachment to a new item on the list using REST API JQuery in SharePoint 2013
- Delete SharePoint List Item attachment using Rest API
- Upload multiple attachments to list items using JSOM and REST API in SharePoint Online/2013/2016
- Calling Rest API from A SharePoint 2013 Designer Workflow
- SharePoint rest api synchronous call using deferred promise and then Example
- Create and delete a file using Rest API in SharePoint Online/2013/2016
- Create, Update and Delete SharePoint List Item using Rest API
- Create or Delete SharePoint Site using Rest API
This SharePoint Rest API tutorial we learned how to use Rest API select, filter, sort and paging in a SharePoint list
Download SharePoint Online Tutorial PDF FREE!
Get update on Webinars, video tutorials, training courses etc.