Posts tagged Hosting fast SharePoint 2013 Hosting

SharePoint 2013 Hosting – HostForLIFE.eu :: Find All Lists And Libraries Using Infopath In SharePoint

May 9th

Posted by Peter in European SharePoint 2013 Hosting

InfoPath is one of the most popular and widely used forms design and development solution that developers and IT consultants use alike, primarily across on-premise versions. However, there are no direct out-of-the-box means of identifying lists/libraries using InfoPath.

Once again, PowerShell comes to the rescue. Using a simple PowerShell, we can easily identify the lists/libraries using InfoPath Forms. We can extend it and generate a report out of it as well.

This script can identify all the lists and libraries that use InfoPath. This can be useful for scenarios like –

Identify lists using InfoPath to consider them for replacement with other solutions like Nintex Forms, K2 SmartForms, etc.
Convert/Re-engineer InfoPath forms to PowerApps
Generate a report containing lists using InfoPath form, and replace them with CSOM designs
User Profile service embedded in InfoPath works differently in SharePoint 2016 than that of SharePoint 2010. A report of all InfoPath enabled list/library will be beneficial to perform the fix.

The Script

#########################################  #### Infopath Usage Identifier       ####  #### Scope - Site Collection         ####  #### Input - Site Collection URL     ####  #########################################       $siteCollectionURL =  "http://sharepoint.devbox.com/sites/mysitecollection"    if((Get-PSSnapin | Where {$_.Name -eq "Microsoft.SharePoint.PowerShell"}) -eq $null)  {      Add-PSSnapin Microsoft.SharePoint.PowerShell;  }    try  {      $mySite = Get-SPSite -Identity $siteCollectionURL      $myWebs = Get-SPWeb -Site $mySite -Limit All         $results = @()      foreach ($myWeb in $myWebs)      {          Write-Host "Looking in WEB: "  $myWeb.Url -ForegroundColor Green          foreach ($myList in $myWeb.Lists)          {              if ($myList.ContentTypes[0].ResourceFolder.Properties["_ipfs_infopathenabled"] -eq $true)              {               Write-Host "Found this list using Infopath -  " $myList.Title -ForegroundColor Blue               $RowDetails = @{                              "Site Collection"  = $siteCollectionURL                              "Web"              = $myWeb                              "List Name"        = $myList.Title                              "List URL"         = $myList.DefaultViewUrl                                                      }               $results += New-Object PSObject -Property $RowDetails              }          }          $myFileName = [Environment]::GetFolderPath("Desktop") + "\InfopathDependencyFinder-SiteCollectionScope-" +  (Get-Date).ToString('MM-dd-yyyy') + ".csv"          $results | export-csv -Path $myFileName -NoTypeInformation           }       Write-Host "---------------------Completed--------------------------" -ForegroundColor Green    }     catch  {      $ErrorMessage = $_.Exception.Message      Write-Host $ErrorMessage  }

######################################### #### Infopath Usage Identifier #### #### Scope - Site Collection #### #### Input - Site Collection URL #### ######################################### $siteCollectionURL = "http://sharepoint.devbox.com/sites/mysitecollection" if((Get-PSSnapin | Where {$_.Name -eq "Microsoft.SharePoint.PowerShell"}) -eq $null) { Add-PSSnapin Microsoft.SharePoint.PowerShell; } try { $mySite = Get-SPSite -Identity $siteCollectionURL $myWebs = Get-SPWeb -Site $mySite -Limit All $results = @() foreach ($myWeb in $myWebs) { Write-Host "Looking in WEB: " $myWeb.Url -ForegroundColor Green foreach ($myList in $myWeb.Lists) { if ($myList.ContentTypes[0].ResourceFolder.Properties["_ipfs_infopathenabled"] -eq $true) { Write-Host "Found this list using Infopath - " $myList.Title -ForegroundColor Blue $RowDetails = @{ "Site Collection" = $siteCollectionURL "Web" = $myWeb "List Name" = $myList.Title "List URL" = $myList.DefaultViewUrl } $results += New-Object PSObject -Property $RowDetails } } $myFileName = [Environment]::GetFolderPath("Desktop") + "\InfopathDependencyFinder-SiteCollectionScope-" + (Get-Date).ToString('MM-dd-yyyy') + ".csv" $results | export-csv -Path $myFileName -NoTypeInformation } Write-Host "---------------------Completed--------------------------" -ForegroundColor Green } catch { $ErrorMessage = $_.Exception.Message Write-Host $ErrorMessage }

The key here is the line below,

$myList.ContentTypes[0].ResourceFolder.Properties[“_ipfs_infopathenabled”] -eq $true

This snippet above checks if the Content Type’s Resource Folder metadata has the InfoPath property – InfoPath Forms Services (_ipfs_infopathenabled) activated on it.

This script runs against site collection, but it can be very easily extended to run across subsite level or even list/library level.

Usage

The script returns the InfoPath lists/libraries below details

Site,
Web,
List/Library Name,
List/Library URL where the form is deployed

The output is in the form of a CSV file which can be very easily be converted into a .xlsx file for further processing and reporting.

SharePoint 2013 Hosting – HostForLIFE.eu :: Get Site Collection From Web Application

Apr 25th

Posted by Peter in European SharePoint 2013 Hosting

We can get the subsites under the site using CSOM easily but if we need to get all the site collections under a specific web application from a SharePoint farm, then we can’t get it directly. For that, we have to use SharePoint search. By using SharePoint Search, we set the “KeywordQuery” to filter and get the site collections. Before using the code block, we should ensure that the SharePoint Search Service Application is running and active.

The code block for this is mentioned below.

    using System;  
    using System.Collections.Generic;  
    using System.Linq;  
    using System.Net;  
    using System.Text;  
    using System.Threading.Tasks;  
    using Microsoft.SharePoint.Client;  
    using Microsoft.SharePoint.Client.Search.Query;  
    namespace GetSitecollFromWebApplication {  
        class GetSitecollByUsingSearch {  
            static void Main(string[] args) {  
                string webAppUrl = string.Empty;  
                string username = string.Empty;  
                string password = string.Empty;  
                NetworkCredential credentials = null;  
                webAppUrl = "webAppUrl"; //Please provide the Web Application URL  
                username = "userName";  
                password = "******";  
                ClientContext ctx = new ClientContext(webAppUrl); //creating ClientContext from given SharePoint Site  
                credentials = new NetworkCredential(username, password); //creating creadential object for SharePoint site.  
                ctx.Credentials = credentials;  
                // Before executing the below code please ensure Search Service Application is running  
                KeywordQuery keyQuery = new KeywordQuery(ctx);  
                keyQuery.QueryText = "contentclass:\"STS_Site\"";  
                keyQuery.RowLimit = 500; // the maximum row limit is 500 for KeywordQuery  
                keyQuery.EnableStemming = true;  
                keyQuery.TrimDuplicates = false;  
                SearchExecutor searchExe = new SearchExecutor(ctx);  
                ClientResult < ResultTableCollection > resultTabColl = searchExe.ExecuteQuery(keyQuery);  
                ctx.ExecuteQuery();  
                var siteCollection = resultTabColl.Value.SelectMany(rs => rs.ResultRows.Select(r => r["Path"])).ToList();  
                if (siteCollection != null && siteCollection.Count > 0) {  
                    foreach(var site in siteCollection) {  
                        Console.WriteLine(site);  
                    }  
                    Console.ReadLine();  
                } else {  
                    Console.WriteLine("Sorry, there were no Site Collections for the Web Application.");  
                    Console.ReadLine();  
                }  
            }  
        }  
    }

using System;

using System.Collections.Generic;

using System.Linq;

using System.Net;

using System.Text;

using System.Threading.Tasks;

using Microsoft.SharePoint.Client;

using Microsoft.SharePoint.Client.Search.Query;

namespace GetSitecollFromWebApplication {

class GetSitecollByUsingSearch {

static void Main(string[] args) {

string webAppUrl = string.Empty;

string username = string.Empty;

string password = string.Empty;

NetworkCredential credentials = null;

webAppUrl = "webAppUrl"; //Please provide the Web Application URL

username = "userName";

password = "******";

ClientContext ctx = new ClientContext(webAppUrl); //creating ClientContext from given SharePoint Site

credentials = new NetworkCredential(username, password); //creating creadential object for SharePoint site.

ctx.Credentials = credentials;

// Before executing the below code please ensure Search Service Application is running

KeywordQuery keyQuery = new KeywordQuery(ctx);

keyQuery.QueryText = "contentclass:\"STS_Site\"";

keyQuery.RowLimit = 500; // the maximum row limit is 500 for KeywordQuery

keyQuery.EnableStemming = true;

keyQuery.TrimDuplicates = false;

SearchExecutor searchExe = new SearchExecutor(ctx);

ClientResult < ResultTableCollection > resultTabColl = searchExe.ExecuteQuery(keyQuery);

ctx.ExecuteQuery();

var siteCollection = resultTabColl.Value.SelectMany(rs => rs.ResultRows.Select(r => r["Path"])).ToList();

if (siteCollection != null && siteCollection.Count > 0) {

foreach(var site in siteCollection) {

Console.WriteLine(site);

}

Console.ReadLine();

} else {

Console.WriteLine("Sorry, there were no Site Collections for the Web Application.");

Console.ReadLine();

}

In this blog, I have explained how you can get all the site Collections under a SharePoint web application. I hope this blog will help you out in a few scenarios.

SharePoint 2013 Hosting – HostForLIFE.eu :: Easy SharePoint ListItem CRUD Operation Using REST API Wrapper

Apr 18th

Posted by Peter in European SharePoint 2013 Hosting

I have read lots of articles on C# Corner, as well as on other online websites about CRUD operations on Sharepoint List. In most articles, I have found some redundant code which can be reused and utilized in such a way that any new developer or learner can learn from the code.

So, based on that, I have started working on creating SPRest Utility which will do lots of work internally to increase development speed with much less coding. As I am still working and it is not fully optimized, there is still redundant code and methods which I have to delete.

SPRest.js

    var SPRest = /** @class */ (function() {  
        function SPRest(rootWeb) {  
            var _this = this;  
            this.Utils = (function() {  
                /** 
                 * Reference or motivation link : https://github.com/omkarkhair/sp-jello/blob/master/lib/jello.js 
                 */  
                var reqUrl = _this.rootUrl + "/_api/web/lists/getbytitle('AWSResponseList')/items";  
                //var fetch = require("node-fetch");  
                // TODO- Need to transform this json to closure function to allow only get operation.  
                //TODO  - Need to add support for Field Meta in utils  
                var spDefaultMeta = {  
                    List: {  
                        BaseTemplate: 100,  
                        // "Title": "List Created with Fetch UTIL1112",  
                        __metadata: { type: "SP.List" }  
                    },  
                    Document: {  
                        __metadata: { type: "SP.List" },  
                        AllowContentTypes: true,  
                        BaseTemplate: 101,  
                        ContentTypesEnabled: true  
                            // 'Description': 'My doc. lib. description',  
                            // 'Title': 'Test'  
                    },  
                    ListItem: {  
                        __metadata: { type: "SP.Data.AWSResponseListListItem" }  
                        // "Title": "Test"  
                    }  
                };  
                console.log(_this.rootUrl);  
                var isOdataVerbose = true;  
                var _rootUrl = _this.rootUrl;  
                //Here "Accept" and "Content-Type" header must require for Sharepoint Onlin REST API  
                var _payloadOptions = {  
                    method: "GET",  
                    body: undefined,  
                    headers: {  
                        credentials: "include",  
                        Accept: "application/json; odata=verbose",  
                        "Content-Type": "application/json; odata=verbose"  
                    }  
                };  
                // TODO- To support for param base odata  
                //No to fetch Metadata, response only requested data.  
                // Reference link https://www.microsoft.com/en-us/microsoft-365/blog/2014/08/13/json-light-support-rest-sharepoint-api-released/  
                //Option 1: verbose “accept: application/json; odata=verbose”  
                //Option 2: minimalmetadata “accept: application/json; odata=minimalmetadata”  
                //Option 3: nometadata “accept: application/json; odata=nometadata”  
                //Option 4: Don’t provide it “accept: application/json” This defaults to minimalmetadata option  
                if (!isOdataVerbose) {  
                    _payloadOptions.headers.Accept = "application/json; odata=nometadata";  
                }  
                // Reference from :https://www.tjvantoll.com/2015/09/13/fetch-and-errors/  
                //Reference rom : https://sharepoint.stackexchange.com/questions/105380/adding-new-list-item-using-rest  
                // Get List Item Type metadata  
                var getItemTypeForListName = function(name) {  
                    return ("SP.Data." +  
                        name.charAt(0).toUpperCase() +  
                        name  
                        .split(" ")  
                        .join("")  
                        .slice(1) +  
                        "ListItem");  
                };  
                var Get = function(url) {  
                    var _localPayload = _payloadOptions;  
                    _localPayload.method = "GET";  
                    //Internally if body is set for GET request then need to remove it by setting undefined  
                    // otherwise it return with error : Failed to execute 'fetch' on 'Window': Request with GET/HEAD method cannot have body  
                    _localPayload.body = undefined;  
                    delete _localPayload.headers["IF-MATCH"];  
                    delete _localPayload.headers["X-HTTP-Method"];  
                    console.log(_localPayload);  
                    return fetch(url, _localPayload).then(function(r) { return r.json(); });  
                };  
                var getRequestDigest = function(url) {  
                    if (url === void 0) { url = ""; }  
                    if (url) {  
                        url = _this.rootUrl;  
                    }  
                    url += "/_api/contextinfo";  
                    var _localPayload = _payloadOptions;  
                    _localPayload.method = "POST";  
                    return fetch(url, _payloadOptions).then(function(r) { return r.json(); });  
                };  
                var postWithRequestDigestExtension = function(url, _a) {  
                    var _b = _a.headers,  
                        headers = _b === void 0 ? {} : _b,  
                        payload = _a.payload;  
                    return getRequestDigest().then(function(token) {  
                        // payload.requestDigest = token.d.GetContextWebInformation.FormDigestValue;  
                        headers["X-RequestDigest"] =  
                            token.d.GetContextWebInformation.FormDigestValue;  
                        return PostExtension(url, { headers: headers, payload: payload });  
                    });  
                };  
                var postWithRequestDigest = function(url, payload) {  
                    return getRequestDigest().then(function(token) {  
                        payload.requestDigest =  
                            token.d.GetContextWebInformation.FormDigestValue;  
                        return Post(url, payload);  
                    });  
                };  
                //Need to refactor below method and need to merge in single method postWithRequestDigestExtension  
                //Based on Action Type in headers using switch case add or remove extra headers  
                // Try to add header name same as standard name so it can be replaced with for loop e.g. _extraHeaders  
                var updateWithRequestDigest = function(url, payload) {  
                    return getRequestDigest(payload.rootUrl + "/_api/contextinfo").then(function(token) {  
                        payload.requestDigest =  
                            token.d.GetContextWebInformation.FormDigestValue;  
                        payload._extraHeaders = {  
                            "IF-MATCH": "*",  
                            "X-HTTP-Method": "MERGE"  
                        };  
                        //For Update operation or Merge Operation no response will return only status will return for http request  
                        payload.isNoJsonResponse = true;  
                        return Post(url, payload);  
                    });  
                };  
                var deleteWithRequestDigest = function(url, payload) {  
                    return getRequestDigest(payload.rootUrl + "/_api/contextinfo").then(function(token) {  
                        payload.requestDigest =  
                            token.d.GetContextWebInformation.FormDigestValue;  
                        payload._extraHeaders = {  
                            "IF-MATCH": "*",  
                            "X-HTTP-Method": "DELETE"  
                        };  
                        //For Update operation or Merge Operation no response will return only status will return for http request  
                        payload.isNoJsonResponse = true;  
                        return Post(url, payload);  
                    });  
                };  
                var Post = function(url, payload) {  
                    var _localPayload = _payloadOptions;  
                    // TODO For Safety this method can be wrapped with request Digest so always get token.  
                    // But need to ensure it request only when request digest is expired.  
                    _localPayload.method = "POST";  
                    _localPayload.body = payload.data;  
                    var _metaInfo = payload.metaInfo;  
                    //Pre validation Check Before update body or meta detail  
                    if (_metaInfo && spDefaultMeta[_metaInfo.type]) {  
                        //Update Title and Description while creating new List/Column/Fields  
                        var type = _metaInfo.type,  
                            title = _metaInfo.title,  
                            listName = _metaInfo.listName;  
                        var _body = spDefaultMeta[type];  
                        if (title) {  
                            //Update title if it is present in metaInfo  
                            _body.Title = title;  
                        }  
                        if (type === "ListItem") {  
                            //TODO Extra Efforts  
                            _body.__metadata.type = getItemTypeForListName(listName);  
                        }  
                        //If Extra fields are present then store to payload  
                        //Before Stringify ,store extra fields/columns in body  
                        if (payload.extraFields) {  
                            for (var field in payload.extraFields) {  
                                //Add all extra columns in body  
                                // TODO- Need to ensure that column value is stringify  
                                _body[field] = payload.extraFields[field];  
                            }  
                            // Merge two object  
                            // _localPayload.body = Object.assign({}, _localPayload.body, payload.extraFields)  
                        }  
                        //Pass body data as stringyfy;  
                        _localPayload.body = JSON.stringify(_body);  
                        _localPayload.body.Title = title;  
                    }  
                    //If Extra header is present in payload for update or other operation, Append to existing header  
                    if (payload._extraHeaders) {  
                        for (var _header in payload._extraHeaders) {  
                            _localPayload.headers[_header] = payload._extraHeaders[_header];  
                        }  
                    } else {  
                        //IF Not present that means it is POST Request, reset Extraheader for this request  
                        _localPayload.headers["IF-MATCH"] = undefined;  
                        _localPayload.headers["X-HTTP-Method"] = undefined;  
                    }  
                    _localPayload.headers["X-RequestDigest"] = payload.requestDigest;  
                    console.log(_localPayload);  
                    //TODO- Naming convention can be updated.  
                    if (payload.isNoJsonResponse) {  
                        return fetch(url, _localPayload).then(function(r) { return r; });  
                    } else {  
                        return fetch(url, _localPayload).then(function(r) { return r.json(); });  
                    }  
                };  
                var PostExtension = function(url, _a) {  
                    var headers = _a.headers,  
                        payload = _a.payload;  
                    var _localPayload = {};  
                    _localPayload = _payloadOptions;  
                    // TODO For Safety this method can be wrapped with request Digest so always get token.  
                    // But need to ensure it request only when request digest is expired.  
                    _localPayload.method = "POST";  
                    //If Extra header is present in payload for update or other operation, Append to existing header  
                    if (headers) {  
                        for (var _header in headers) {  
                            _localPayload.headers[_header] = headers[_header];  
                        }  
                    }  
                    //Below code not required to reset functionality  
                    //    else {  
                    //     //IF Not present that means it is POST Request, reset Extraheader for this request  
                    //     __copyPayloadOptions.headers["IF-MATCH"] = undefined;  
                    //     __copyPayloadOptions.headers["X-HTTP-Method"] = undefined;  
                    //   }  
                    //TODO -Assume payload is in object so applied stringyfy other wise need check before apply  
                    _localPayload.body = JSON.stringify(payload.data);  
                    // console.log(_payloadOptions);  
                    //TODO- Naming convention can be updated.  
                    // if (payload.isNoJsonResponse) {  
                    //Instead of storing  extra info in payload use headers  
                    if (payload.isNoJsonResponse) {  
                        return fetch(url, _localPayload).then(function(r) { return r; });  
                    } else {  
                        return fetch(url, _localPayload).then(function(r) { return r.json(); });  
                    }  
                };  
                var generateRestRequest = function(_a) {  
                    var _b = _a.listName,  
                        listName = _b === void 0 ? "" : _b,  
                        _c = _a.Id,  
                        Id = _c === void 0 ? "" : _c,  
                        type = _a.type;  
                    var prepareRequest = _this.rootUrl + "/_api/web/lists";  
                    switch (type) {  
                        case "ListItem":  
                            prepareRequest += "/getbytitle('" + listName + "')/items";  
                            if (Id) {  
                                prepareRequest += "(" + Id + ")";  
                            }  
                            break;  
                        case "List":  
                            if (listName) {  
                                prepareRequest += "/getbytitle('" + listName + "')";  
                            }  
                            //TODO  
                            break;  
                    }  
                    //OLDER Code for ListItem  
                    //   prepareRequest = `/getbytitle('${listName}')/items`;  
                    //   if (Id) {  
                    //     prepareRequest += `(${Id})`;  
                    //   }  
                    return prepareRequest;  
                };  
                //Provide support for odata query so, for specific provided expression append it with base requet  
                var ListItem = {  
                    Add: function(_a) {},  
                    Update: function(_a) {},  
                    Delete: function(_a) {},  
                    GetItemById: function(_a) {},  
                    GetAllItem: function(_a) {}  
                };  
                var List = {  
                    Add: function(_a) {},  
                    Update: function(_a) {  
                        console.log("Implementation is pending");  
                    },  
                    Delete: function(_a) {  
                        console.log("Implementation is pending");  
                    },  
                    GetItemById: function(_a) {  
                        console.log("Implementation is pending");  
                    },  
                    GetAll: function(_a) {}  
                };  
                List.GetAll = function() {  
                    return Get(generateRestRequest({ listName: "", type: "List" }));  
                };  
                List.Add = function(_a) {  
                    var listName = _a.listName,  
                        data = _a.data;  
                    var _reqUrl = generateRestRequest({ listName: listName, type: "List" });  
                    var _prePayload = preparePayloadData({  
                        action: "ADD",  
                        type: "List",  
                        listName: listName,  
                        data: data  
                    });  
                    return postWithRequestDigestExtension(_reqUrl, _prePayload);  
                };  
                ListItem.GetAllItem = function(_a) {  
                    var listName = _a.listName;  
                    return Get(generateRestRequest({ listName: listName, type: "ListItem" }));  
                };  
                ListItem.GetItemById = function(_a) {  
                    var listName = _a.listName,  
                        Id = _a.Id;  
                    return Get(generateRestRequest({ listName: listName, Id: Id, type: "ListItem" }));  
                };  
                // Add/Update/Delete require same types of metaData as well as payload only difference is Headers  
                ListItem.Add = function(_a) {  
                    var listName = _a.listName,  
                        data = _a.data;  
                    var _reqUrl = generateRestRequest({ listName: listName, type: "ListItem" });  
                    var _prePayload = preparePayloadData({  
                        action: "ADD",  
                        type: "ListItem",  
                        listName: listName,  
                        data: data  
                    });  
                    return postWithRequestDigestExtension(_reqUrl, _prePayload);  
                };  
                ListItem.Update = function(_a) {  
                    var listName = _a.listName,  
                        Id = _a.Id,  
                        data = _a.data;  
                    var _reqUrl = generateRestRequest({ listName: listName, Id: Id, type: "ListItem" });  
                    var _prePayload = preparePayloadData({  
                        action: "UPDATE",  
                        type: "ListItem",  
                        listName: listName,  
                        data: data  
                    });  
                    return postWithRequestDigestExtension(_reqUrl, _prePayload);  
                };  
                ListItem.Delete = function(_a) {  
                    var listName = _a.listName,  
                        Id = _a.Id,  
                        data = _a.data;  
                    var _reqUrl = generateRestRequest({ listName: listName, Id: Id, type: "ListItem" });  
                    var _prePayload = preparePayloadData({  
                        action: "DELETE",  
                        type: "ListItem",  
                        listName: listName,  
                        data: data  
                    });  
                    return postWithRequestDigestExtension(_reqUrl, _prePayload);  
                };  
                var preparePayloadData = function(_a) {  
                    var listName = _a.listName,  
                        data = _a.data,  
                        action = _a.action,  
                        type = _a.type;  
                    var payload = {  
                        data: { __metadata: spDefaultMeta[type] }  
                    };  
                    //payload.data = {};  
                    //   let _metaInfo: any = spDefaultMeta["ListItem"];  
                    //   _metaInfo.__metadata.type = getItemTypeForListName(listName);  
                    // payload.data.__metadata=spDefaultMeta["ListItem"];  
                    switch (type) {  
                        case "ListItem":  
                            //Update ListItem Content type  
                            payload.data.__metadata.type = getItemTypeForListName(listName);  
                            break;  
                    }  
                    //Need to check is data is object then iterate otherwise not  
                    if (data) {  
                        for (var _key in data) {  
                            payload.data[_key] = data[_key];  
                        }  
                    }  
                    //TODO Verify about extra header  
                    // //Pass body data as stringyfy;  
                    // // _payloadOptions.body = JSON.stringify(_body);  
                    // // _payloadOptions.body.Title = title;  
                    //    return postWithRequestDigest(_reqUrl);  
                    var _headers = {};  
                    switch (action) {  
                        case "ADD":  
                            _headers = {  
                                "IF-MATCH": undefined,  
                                "X-HTTP-Method": undefined  
                            };  
                            break;  
                        case "UPDATE":  
                            _headers = {  
                                "IF-MATCH": "*",  
                                "X-HTTP-Method": "MERGE"  
                            };  
                            //For Update operation or Merge Operation no response will return only status will return for http request  
                            payload.isNoJsonResponse = true;  
                            break;  
                        case "DELETE":  
                            _headers = {  
                                "IF-MATCH": "*",  
                                "X-HTTP-Method": "DELETE"  
                            };  
                            //For Update operation or Merge Operation no response will return only status will return for http request  
                            payload.isNoJsonResponse = true;  
                            break;  
                    }  
                    return { headers: _headers, payload: payload };  
                };  
                return {  
                    List: List,  
                    ListItem: ListItem,  
                    Get: Get,  
                    getRequestDigest: getRequestDigest,  
                    Post: postWithRequestDigest,  
                    Update: updateWithRequestDigest,  
                    Delete: deleteWithRequestDigest  
                };  
            })();  
            this.rootUrl = rootWeb;  
        }  
        return SPRest;  
    }());

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

var SPRest = /** @class */ (function() {

function SPRest(rootWeb) {

var _this = this;

this.Utils = (function() {

/**

* Reference or motivation link : https://github.com/omkarkhair/sp-jello/blob/master/lib/jello.js

var reqUrl = _this.rootUrl + "/_api/web/lists/getbytitle('AWSResponseList')/items";

//var fetch = require("node-fetch");

// TODO- Need to transform this json to closure function to allow only get operation.

//TODO - Need to add support for Field Meta in utils

var spDefaultMeta = {

List: {

BaseTemplate: 100,

// "Title": "List Created with Fetch UTIL1112",

__metadata: { type: "SP.List" }

Document: {

__metadata: { type: "SP.List" },

AllowContentTypes: true,

BaseTemplate: 101,

ContentTypesEnabled: true

// 'Description': 'My doc. lib. description',

// 'Title': 'Test'

ListItem: {

__metadata: { type: "SP.Data.AWSResponseListListItem" }

// "Title": "Test"

}

};

console.log(_this.rootUrl);

var isOdataVerbose = true;

var _rootUrl = _this.rootUrl;

//Here "Accept" and "Content-Type" header must require for Sharepoint Onlin REST API

var _payloadOptions = {

method: "GET",

body: undefined,

headers: {

credentials: "include",

Accept: "application/json; odata=verbose",

"Content-Type": "application/json; odata=verbose"

}

};

// TODO- To support for param base odata

//No to fetch Metadata, response only requested data.

// Reference link https://www.microsoft.com/en-us/microsoft-365/blog/2014/08/13/json-light-support-rest-sharepoint-api-released/

//Option 1: verbose “accept: application/json; odata=verbose”

//Option 2: minimalmetadata “accept: application/json; odata=minimalmetadata”

//Option 3: nometadata “accept: application/json; odata=nometadata”

//Option 4: Don’t provide it “accept: application/json” This defaults to minimalmetadata option

if (!isOdataVerbose) {

_payloadOptions.headers.Accept = "application/json; odata=nometadata";

}

// Reference from :https://www.tjvantoll.com/2015/09/13/fetch-and-errors/

//Reference rom : https://sharepoint.stackexchange.com/questions/105380/adding-new-list-item-using-rest

// Get List Item Type metadata

var getItemTypeForListName = function(name) {

return ("SP.Data." +

name.charAt(0).toUpperCase() +

name

.split(" ")

.join("")

.slice(1) +

"ListItem");

};

var Get = function(url) {

var _localPayload = _payloadOptions;

_localPayload.method = "GET";

//Internally if body is set for GET request then need to remove it by setting undefined

// otherwise it return with error : Failed to execute 'fetch' on 'Window': Request with GET/HEAD method cannot have body

_localPayload.body = undefined;

delete _localPayload.headers["IF-MATCH"];

delete _localPayload.headers["X-HTTP-Method"];

console.log(_localPayload);

return fetch(url, _localPayload).then(function(r) { return r.json(); });

};

var getRequestDigest = function(url) {

if (url === void 0) { url = ""; }

if (url) {

url = _this.rootUrl;

}

url += "/_api/contextinfo";

var _localPayload = _payloadOptions;

_localPayload.method = "POST";

return fetch(url, _payloadOptions).then(function(r) { return r.json(); });

};

var postWithRequestDigestExtension = function(url, _a) {

var _b = _a.headers,

headers = _b === void 0 ? {} : _b,

payload = _a.payload;

return getRequestDigest().then(function(token) {

// payload.requestDigest = token.d.GetContextWebInformation.FormDigestValue;

headers["X-RequestDigest"] =

token.d.GetContextWebInformation.FormDigestValue;

return PostExtension(url, { headers: headers, payload: payload });

});

};

var postWithRequestDigest = function(url, payload) {

return getRequestDigest().then(function(token) {

payload.requestDigest =

token.d.GetContextWebInformation.FormDigestValue;

return Post(url, payload);

});

};

//Need to refactor below method and need to merge in single method postWithRequestDigestExtension

//Based on Action Type in headers using switch case add or remove extra headers

// Try to add header name same as standard name so it can be replaced with for loop e.g. _extraHeaders

var updateWithRequestDigest = function(url, payload) {

return getRequestDigest(payload.rootUrl + "/_api/contextinfo").then(function(token) {

payload.requestDigest =

token.d.GetContextWebInformation.FormDigestValue;

payload._extraHeaders = {

"IF-MATCH": "*",

"X-HTTP-Method": "MERGE"

};

//For Update operation or Merge Operation no response will return only status will return for http request

payload.isNoJsonResponse = true;

return Post(url, payload);

});

};

var deleteWithRequestDigest = function(url, payload) {

return getRequestDigest(payload.rootUrl + "/_api/contextinfo").then(function(token) {

payload.requestDigest =

token.d.GetContextWebInformation.FormDigestValue;

payload._extraHeaders = {

"IF-MATCH": "*",

"X-HTTP-Method": "DELETE"

};

//For Update operation or Merge Operation no response will return only status will return for http request

payload.isNoJsonResponse = true;

return Post(url, payload);

});

};

var Post = function(url, payload) {

var _localPayload = _payloadOptions;

// TODO For Safety this method can be wrapped with request Digest so always get token.

// But need to ensure it request only when request digest is expired.

_localPayload.method = "POST";

_localPayload.body = payload.data;

var _metaInfo = payload.metaInfo;

//Pre validation Check Before update body or meta detail

if (_metaInfo && spDefaultMeta[_metaInfo.type]) {

//Update Title and Description while creating new List/Column/Fields

var type = _metaInfo.type,

title = _metaInfo.title,

listName = _metaInfo.listName;

var _body = spDefaultMeta[type];

if (title) {

//Update title if it is present in metaInfo

_body.Title = title;

}

if (type === "ListItem") {

//TODO Extra Efforts

_body.__metadata.type = getItemTypeForListName(listName);

}

//If Extra fields are present then store to payload

//Before Stringify ,store extra fields/columns in body

if (payload.extraFields) {

for (var field in payload.extraFields) {

//Add all extra columns in body

// TODO- Need to ensure that column value is stringify

_body[field] = payload.extraFields[field];

}

// Merge two object

// _localPayload.body = Object.assign({}, _localPayload.body, payload.extraFields)

}

//Pass body data as stringyfy;

_localPayload.body = JSON.stringify(_body);

_localPayload.body.Title = title;

}

//If Extra header is present in payload for update or other operation, Append to existing header

if (payload._extraHeaders) {

for (var _header in payload._extraHeaders) {

_localPayload.headers[_header] = payload._extraHeaders[_header];

}

} else {

//IF Not present that means it is POST Request, reset Extraheader for this request

_localPayload.headers["IF-MATCH"] = undefined;

_localPayload.headers["X-HTTP-Method"] = undefined;

}

_localPayload.headers["X-RequestDigest"] = payload.requestDigest;

console.log(_localPayload);

//TODO- Naming convention can be updated.

if (payload.isNoJsonResponse) {

return fetch(url, _localPayload).then(function(r) { return r; });

} else {

return fetch(url, _localPayload).then(function(r) { return r.json(); });

}

};

var PostExtension = function(url, _a) {

var headers = _a.headers,

payload = _a.payload;

var _localPayload = {};

_localPayload = _payloadOptions;

// TODO For Safety this method can be wrapped with request Digest so always get token.

// But need to ensure it request only when request digest is expired.

_localPayload.method = "POST";

//If Extra header is present in payload for update or other operation, Append to existing header

if (headers) {

for (var _header in headers) {

_localPayload.headers[_header] = headers[_header];

}

//Below code not required to reset functionality

// else {

// //IF Not present that means it is POST Request, reset Extraheader for this request

// __copyPayloadOptions.headers["IF-MATCH"] = undefined;

// __copyPayloadOptions.headers["X-HTTP-Method"] = undefined;

// }

//TODO -Assume payload is in object so applied stringyfy other wise need check before apply

_localPayload.body = JSON.stringify(payload.data);

// console.log(_payloadOptions);

//TODO- Naming convention can be updated.

// if (payload.isNoJsonResponse) {

//Instead of storing extra info in payload use headers

if (payload.isNoJsonResponse) {

return fetch(url, _localPayload).then(function(r) { return r; });

} else {

return fetch(url, _localPayload).then(function(r) { return r.json(); });

}

};

var generateRestRequest = function(_a) {

var _b = _a.listName,

listName = _b === void 0 ? "" : _b,

_c = _a.Id,

Id = _c === void 0 ? "" : _c,

type = _a.type;

var prepareRequest = _this.rootUrl + "/_api/web/lists";

switch (type) {

case "ListItem":

prepareRequest += "/getbytitle('" + listName + "')/items";

if (Id) {

prepareRequest += "(" + Id + ")";

}

break;

case "List":

if (listName) {

prepareRequest += "/getbytitle('" + listName + "')";

}

//TODO

break;

}

//OLDER Code for ListItem

// prepareRequest = `/getbytitle('${listName}')/items`;

// if (Id) {

// prepareRequest += `(${Id})`;

// }

return prepareRequest;

};

//Provide support for odata query so, for specific provided expression append it with base requet

var ListItem = {

Add: function(_a) {},

Update: function(_a) {},

Delete: function(_a) {},

GetItemById: function(_a) {},

GetAllItem: function(_a) {}

};

var List = {

Add: function(_a) {},

Update: function(_a) {

console.log("Implementation is pending");

Delete: function(_a) {

console.log("Implementation is pending");

GetItemById: function(_a) {

console.log("Implementation is pending");

GetAll: function(_a) {}

};

List.GetAll = function() {

return Get(generateRestRequest({ listName: "", type: "List" }));

};

List.Add = function(_a) {

var listName = _a.listName,

data = _a.data;

var _reqUrl = generateRestRequest({ listName: listName, type: "List" });

var _prePayload = preparePayloadData({

action: "ADD",

type: "List",

listName: listName,

data: data

});

return postWithRequestDigestExtension(_reqUrl, _prePayload);

};

ListItem.GetAllItem = function(_a) {

var listName = _a.listName;

return Get(generateRestRequest({ listName: listName, type: "ListItem" }));

};

ListItem.GetItemById = function(_a) {

var listName = _a.listName,

Id = _a.Id;

return Get(generateRestRequest({ listName: listName, Id: Id, type: "ListItem" }));

};

// Add/Update/Delete require same types of metaData as well as payload only difference is Headers

ListItem.Add = function(_a) {

var listName = _a.listName,

data = _a.data;

var _reqUrl = generateRestRequest({ listName: listName, type: "ListItem" });

var _prePayload = preparePayloadData({

action: "ADD",

type: "ListItem",

listName: listName,

data: data

});

return postWithRequestDigestExtension(_reqUrl, _prePayload);

};

ListItem.Update = function(_a) {

var listName = _a.listName,

Id = _a.Id,

data = _a.data;

var _reqUrl = generateRestRequest({ listName: listName, Id: Id, type: "ListItem" });

var _prePayload = preparePayloadData({

action: "UPDATE",

type: "ListItem",

listName: listName,

data: data

});

return postWithRequestDigestExtension(_reqUrl, _prePayload);

};

ListItem.Delete = function(_a) {

var listName = _a.listName,

Id = _a.Id,

data = _a.data;

var _reqUrl = generateRestRequest({ listName: listName, Id: Id, type: "ListItem" });

var _prePayload = preparePayloadData({

action: "DELETE",

type: "ListItem",

listName: listName,

data: data

});

return postWithRequestDigestExtension(_reqUrl, _prePayload);

};

var preparePayloadData = function(_a) {

var listName = _a.listName,

data = _a.data,

action = _a.action,

type = _a.type;

var payload = {

data: { __metadata: spDefaultMeta[type] }

};

//payload.data = {};

// let _metaInfo: any = spDefaultMeta["ListItem"];

// _metaInfo.__metadata.type = getItemTypeForListName(listName);

// payload.data.__metadata=spDefaultMeta["ListItem"];

switch (type) {

case "ListItem":

//Update ListItem Content type

payload.data.__metadata.type = getItemTypeForListName(listName);

break;

}

//Need to check is data is object then iterate otherwise not

if (data) {

for (var _key in data) {

payload.data[_key] = data[_key];

}

//TODO Verify about extra header

// //Pass body data as stringyfy;

// // _payloadOptions.body = JSON.stringify(_body);

// // _payloadOptions.body.Title = title;

// return postWithRequestDigest(_reqUrl);

var _headers = {};

switch (action) {

case "ADD":

_headers = {

"IF-MATCH": undefined,

"X-HTTP-Method": undefined

};

break;

case "UPDATE":

_headers = {

"IF-MATCH": "*",

"X-HTTP-Method": "MERGE"

};

//For Update operation or Merge Operation no response will return only status will return for http request

payload.isNoJsonResponse = true;

break;

case "DELETE":

_headers = {

"IF-MATCH": "*",

"X-HTTP-Method": "DELETE"

};

//For Update operation or Merge Operation no response will return only status will return for http request

payload.isNoJsonResponse = true;

break;

}

return { headers: _headers, payload: payload };

};

return {

List: List,

ListItem: ListItem,

Get: Get,

getRequestDigest: getRequestDigest,

Post: postWithRequestDigest,

Update: updateWithRequestDigest,

Delete: deleteWithRequestDigest

};

})();

this.rootUrl = rootWeb;

}

return SPRest;

}());

You might be wondering how to use SPRest for CRUD Operation in SharePoint.

First of all, save the above code in a file and then, add the reference to it on the page wherever you want to use it.

Once you have added references, then create the instance of SPRest with one parameter which accepts Sharepoint rootUrl used internally or generating request URL for REST API.

var spRest=new SPRest("https://brgrp.sharepoint.com")

1	var spRest=new SPRest("https://brgrp.sharepoint.com")

For demonstration purposes, I am using “PlaceHolderList” that is having the following columns.

Title -Single line of Text
UserId – Number
Completed -Single line of Text

Get All List Items from Sharepoint List

By default, SharePoint List returns the top 100 records if you have more than 100 records in the list.

    // Get All Item from List item  
    spRest.Utils.ListItem.GetAllItem({listName:"PlaceHolderList"}).then(function(r){  
    console.log(r);  
    // Response received. TODO bind record to table or somewhere else.  
    });

// Get All Item from List item

spRest.Utils.ListItem.GetAllItem({listName:"PlaceHolderList"}).then(function(r){

console.log(r);

// Response received. TODO bind record to table or somewhere else.

});

Get List Item from SharePoint List by Id

// Get List Item By Id  
spRest.Utils.ListItem.GetItemById({listName:"PlaceHolderList",Id:201}).then(function(r){    
console.log(r);    
// Response received.   
});

// Get List Item By Id

spRest.Utils.ListItem.GetItemById({listName:"PlaceHolderList",Id:201}).then(function(r){

console.log(r);

// Response received.

});

Add New List Item to SharePoint List

    // Add ListItem to Sharepoint List  
    spRest.Utils.ListItem.Add({listName:"PlaceHolderList",data:{Title:"New Item Created For Demo",UserId:1,Completed:"true"}}).then(function(r){    
    console.log(r);    
    // Added New List item response received with newly created item  
    });

// Add ListItem to Sharepoint List

spRest.Utils.ListItem.Add({listName:"PlaceHolderList",data:{Title:"New Item Created For Demo",UserId:1,Completed:"true"}}).then(function(r){

console.log(r);

// Added New List item response received with newly created item

});

Update New List Item By Id in SharePoint List

    // Update List item based on ID with new data in SharePoint List  
    spRest.Utils.ListItem.Update({listName:"PlaceHolderList",Id:201,data:{Title:"Updated List Item",UserId:1,Completed:"true"}}).then(function(r){    
    // List Item Updated and received response with status 204  
    console.log(r);  
    });

// Update List item based on ID with new data in SharePoint List

spRest.Utils.ListItem.Update({listName:"PlaceHolderList",Id:201,data:{Title:"Updated List Item",UserId:1,Completed:"true"}}).then(function(r){

// List Item Updated and received response with status 204

console.log(r);

});

Delete New List Item By Id in SharePoint List

    // Delete List item based on ID  
    spRest.Utils.ListItem.Delete({listName:"PlaceHolderList",Id:201}).then(function(r){    
    // List Item Deleted and received response with status 200  
    console.log(r);  
    });

// Delete List item based on ID

spRest.Utils.ListItem.Delete({listName:"PlaceHolderList",Id:201}).then(function(r){

// List Item Deleted and received response with status 200

console.log(r);

});

As per the above code example for CRUD functionality, it looks like a cleaner and easier way to perform the CRUD opeation on SharePoint List. It has a lot of redundant code.

Generate Request Url Based on Root Site and List Name and Id
Header accept and Content type
RequestDigest Headers
Combined Delete/Update/Add Code with reusable functions to prepare payload data for the request
Adding and applying metadata for ListItem based on ListName

I removed and combined with reusable functions so it can be used for extending List and Document Library in future. I hope you find this article and utilities helpful. Let me know your comments and any suggestion to extend SPRest util.

Conclusion

In this article, we have learned about an easy and cleaner way to do CRUD Operations with SharePoint List Items using SPRest.

Posts tagged Hosting fast SharePoint 2013 Hosting

SharePoint 2013 Hosting – HostForLIFE.eu :: Find All Lists And Libraries Using Infopath In SharePoint

SharePoint 2013 Hosting – HostForLIFE.eu :: Get Site Collection From Web Application

SharePoint 2013 Hosting – HostForLIFE.eu :: Easy SharePoint ListItem CRUD Operation Using REST API Wrapper

Get All List Items from Sharepoint List

Conclusion

BLOGROLL

Featured On

Posts tagged Hosting fast SharePoint 2013 Hosting

SharePoint 2013 Hosting – HostForLIFE.eu :: Find All Lists And Libraries Using Infopath In SharePoint

SharePoint 2013 Hosting – HostForLIFE.eu :: Get Site Collection From Web Application

SharePoint 2013 Hosting – HostForLIFE.eu :: Easy SharePoint ListItem CRUD Operation Using REST API Wrapper

Get All List Items from Sharepoint List

Conclusion

BLOGROLL

Featured On

Tags