Fetching SharePoint List Items Using A Simple HTTP REST Command

In this article, I will introduce you to an online service I created that allows you to code against certain services without using an SDK, simply by sending HTTPS REST commands. In this article, I will demonstrate how this works against SharePoint Online; however other services are also available.

Please note that I built this service with the community in mind, and as a result, it is free for simple use. The service stores your configuration settings securely so that the actual service secrets (such as your SharePoint password) are not stored on the client code.

Developing without an SDK makes it much easier to code IoT, web and Mobile projects, and works regardless of the operating system or programming language. That's because you can make simple REST commands instead of using an SDK; the call returns a JSON payload with the data.

Let's see how we can fetch SharePoint List Items using a simple HTTP REST command. The REST method to call is called GetListItemEx. Let's first look at a raw HTTP command that you can send using Postman for example. There are a few variables to change, which we will review.

GET ENZO_URI/bsc/sharepoint/getlistitemsex HTTP/1.1
authToken: YOUR_AUTH_TOKEN
_config: myconfigname
viewname: mylist
where: State='FL'

The following variables should be replaced in the above code:

• ENZO_URI: this is the URI of your Enzo service endpoint that is assigned to you on the portal
• YOUT_AUTH_TOKEN: this is your assigned authToken, also available on the portal
• myconfigname: this is a configuration name that you created in the portal that points to SharePoint
• viewname: the name of the SharePoint list
• where: an optional WHERE clause that looks like a SQL where clause

For example, the following Postman screenshot shows you the REST command I sent to my server, which in turn connected to SharePoint Online to fetch items from the US States list. The name of the configuration is called sharepointroggero (we will see this shortly).

 

As you can see, there are no SharePoint-specific secrets here; all the details are stored on the portal under the configuration setting called sharepointroggero. Let’s go to the portal and review the configuration settings; once you log in to the portal, click on the SharePoint service on the left, and click on Create. You will see a screen similar to this where you can store your configuration settings.

 

Now let’s create a small C# Console project to make the same REST call. To try the following source code, you will need to sign up on the Enzo Online portal here, create a configuration setting for SharePoint Online and access your Enzo URI and AuthToken by selecting Enzo Accounts from the menu. The code does essentially the same thing as above: it retrieves the content of a list called MyList using a configuration setting called myconfigname. As discussed previously, this code does not use the SharePoint SDK; it relies entirely on HTTPS REST calls.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Text;
using System.Threading.Tasks;

namespace Sample
{
class Program
{
static void Main(string[] args)
{
    string url = "https://ENZO_URI/bsc/sharepoint/getlistitemsex";
    string authId = "YOUR_AUTH_ID";
    WebRequest wr = WebRequest.CreateHttp(url);
    try
    {
        // Add the required HTTP headers for the call
        wr.Headers.Add("authToken", authId);
        wr.Headers.Add("viewname", "mylist");
        wr.Headers.Add("_config", "myconfigname");
        wr.Method = "GET";
        var resp = wr.GetResponse();    // Execute the command
        using (var stream = resp.GetResponseStream())
        {
        }
        Console.WriteLine("HTTP Response: " + ((System.Net.HttpWebResponse)(resp)).StatusCode);

    }
    catch (Exception ex)
    {
        Console.WriteLine("ERROR: Response from " + baseUrl + command + ":" + ex.Message);
    }
    Console.ReadKey();
}
}
}

Similarly, here is a Python sample code that does essentially the same thing.

import sys
import urllib
import urllib2
import requests

enzourl_receiveMsg="https://ENZO_URI:ENZO_PORT/bsc/sharepoint/getlistitemsex"
enzo_guid="YOUR_AUTH_ID"

#create the headers this call expects
headers={
    'authToken': enzoguid,
    'viewname': 'mylist',
    '_config': 'myconfigname'
}
response=requests.get(enzourl_receiveMsg,headers=headers)

The purpose of this article was to introduce you to a new development approach that simplifies development, and removes complex SDKs from client code using SharePoint as an example. Additional documentation and sample code is available online.