SharePoint REST API: Selecting, Filtering, Sorting Results in a SharePoint List

By -
In this post we will see samples about $select, $orderby, $filter and $expand.


1.Simple API call:
{siteUrl}/_api/web/lists/getbytitle('ListName')/items


2.Select Columns:
{siteUrl}/_api/web/lists/getbytitle('Employees')/items?$select=ID,Title,Employee


3.OrderBy Columns:
  • Ascending order: {siteUrl}/_api/web/lists/getbytitle('Employees')/items?$select=ID,Title,Employee&$orderby= Employee asc
  • Descending order: {siteUrl}/_api/web/lists/getbytitle('Employees')/items?$select=ID,Title,Employee&$orderby= Employee desc

4.Filtering Columns:
  • Filtering by Title:{siteUrl}/_api/web/lists/getbytitle('Employees')/items?$filter= Employee eq ‘parth' 
  • Filtering by ID:{siteUrl}/_api/web/lists/getbytitle('Employees')/items?$filter= ID eq 2
  • Filtering by Date: {siteUrl}/_api/web/lists/getbytitle('Employees')/items?$filter=Start_x0020_Date le datetime'2016-03-26T09:59:32Z'
  • Title name starts with the letter P:{siteUrl}/_api/web/lists/getbytitle('Employees')/items?$filter=startswith(Title,‘P’)
  • Return all items from the "Employees" modified in May:{siteUrl}/_api/web/lists/getbytitle('Employees')/items?$filter=month(Modified) eq 5

  • You can also use multiple filters using the and operator to combine them, and wrapping each filter condition in a parenthesis:{siteUrl}/_api/web/lists/getbytitle('Employees')/items?$filter=(Modified le datetime'2016-03-26T09:59:32Z') and (ID eq 2)

5.Expanding for a person or lookup fields:

   To get values from Person or Lookup fields, we can use Expand to retrieve values.

  • Lookup field:  City lookup column : {siteUrl}/_api/web/lists/getbytitle('Employees')/items?$select=ID,Title,Employee,company,city/Title&$expand= city/Id
  • People field: People field Author:{siteUrl}/_api/web/lists/getbytitle('Employees')/items?$select=Author/Title&$expand=Author/Id

  •  Lookup Column other properties:(Lookup properties will give parent list columns values)
  •  /_api/lists/getbytitle('ListName')/items?select=Title,LookupField/Id,LookupField/Title,LookupField/Modified,
    • LookupField/Created&$expand=LookupField/Id
  • People Column other properties:
    • "1 Id 2 ContentTypeID 3 ContentType 4 Name 5 Modified 6 Created 7 Account 8 EMail 9 MobileNumber 10 AboutMe 11 SIPAddress 12 IsSiteAdmin 13 Deleted 14 Hidden 15 Picture 16 Department 17 JobTitle 18 LastName 19 FirstName"
      /items?$select=Users/EMail,Users/FirstName,Users/LastName,Users/EMail&$expand=Users/Id

5.Expanding Metadata fields:(link)

    We can use "TaxCatchAll" keyword to expand metadata column. here Location & department is metadata columns.
url: _spPageContextInfo.siteServerRelativeUrl +
      "/_api/web/lists/getbytitle('ListName')/items?" +
      "$select=ID,Title," +
      "MyLocation,MyDepartment," +
      "TaxCatchAll/ID,TaxCatchAll/Term," +
      "&$expand=TaxCatchAll" +
      "&$top=5000",

Comments

Post a Comment

Popular posts from this blog

Upload Single/Multiple file by using the REST API and jQuery SharePoint 2013

By -
Image
Upload  Single/Multiple  file by using the REST API and jQuery SharePoint 2013 Here you can find how to upload single/multiple file in SharePoint 2013 Library using Rest API. We can use the Content Editor web part to call the script files. Include Script files in Content Editor: Go to content editor -> Edit Source -> enter the code like below (code for including the script files) For 'jquery.min.js' we can either use direct link from online or we can download to our SharePoint library & We can use that. <script src=" https://ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js" ></script> OR use the below code <script src="/ sites/<SiteName>/<Subsite>/SiteAssets/jquery-1.11.1.min.j s"></script> <script src="/ sites/ <SiteName>/<Subsite> /SiteAssets/taskpage.js " type="text/javascript"></script> <script src=" /sites/ <SiteName>/<Subs
Read more

A type named 'SP.Data. could not be resolved by the model error

By -
Image
When we are trying to update task list we will get this error " A type named 'SP.Data. could not be resolved by the model error. When a model is available, each type name must resolve to a valid name must resolve to a a valid type" This happens because there is a space in the list name. To resolve this issue we need to get the exact list name to be used in "SP.Data" 1.Use the below URL in chrome browser <SiteUrl>/_api/web/lists/GetByTitle('List Name')/ For Example:  https://SiteURL/_api/web/lists/GetByTitle('Workflow Tasks')/ Some times in Chrome browser you may get Authentication error. For that first open the list from your Chrome browser & then use the above URL. 2.Find "SP.Data" -> now you will get the list name that you can be used in SP.Data.ListNameListitem
Read more

Add content type to SharePoint List/Library using REST API

By -
Add content type to SharePoint List/Library using REST API Use this below code to add content type to SharePoint Library using REST API. For this you need to use the content type ID. Below function will get the content type ID from content type name & we will pass the content type id to next function which will update content type to list/library. var   varContentTypeName = " Your Content Type name "; var   Listname = " Your List name where you want to add content type "; //This will get the content type ID from content type Name function  getContentTypeID() { var deferred = $.Deferred();     var  isCurrentUserIsApprover = false ; var  serverURL = _spPageContextInfo.webAbsoluteUrl; var  listURL = String.format(" {0}/_api/web/AvailableContentTypes?$select=Name,Id,StringId&$filter=Name eq '"+varContentTypeName+"' ",serverURL); $.ajax({ url: listURL, type: " GET ", async: false, headers:
Read more