Posts tagged trick SharePoint 2013 Hosting

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

No comments

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.

SharePoint 2013 Hosting – HostForLIFE.eu :: SharePoint Search Application Returns “The Content Processing Pipeline Failed To Process The Item” Error On Crawl

Apr 11th

Posted by Peter in European SharePoint 2013 Hosting

No comments

Recently, I faced one strange issue on my SharePoint farm. My documents were not crawling and they were showing the below error.

Error

The Content Processing pipeline failed to process the item. (Index was out of range. Must be non-negative and less than the size of the collection. Parameter name: index; ; searchID=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXXX)

So after some analysis, I learned that this line comes up when some required managed properties in the search schema are set to ‘Allow Multiple Values’.

To find which managed properties are causing the problem, just log in to your application server where the search is configured and open the recent ULS log and do a keyword search for “Content processing”. You can find the log line like below.

NodeRunnerContent1-1af8a817-055 (0x142C) 0x2934 Search Content Processing awyjr Monitorable “PropertyMapperProducer[[Microsoft.CrawlerFlow-4c7cf676-1194-43d3-b176-a4b39c6fedec]]: Failed to map values to field Keywords. Metadata: OutputAsList True, Type String, RemoveDuplicates True” dd750643-71e0-4d79-962c-6e47c472d02d

Finally, in my case, “Keywords” managed properties was causing the problem, so I went to my search administration page and search schema and searched for “keywords” managed properties

Then, I removed Multi from the managed properties and ran the full crawl. Then, the above-mentioned error disappeared and all documents crawled successfully.

These troubleshooting steps cleared all my “Content Processing pipeline failed” errors and I don’t get those errors again.

SharePoint 2013 Hosting – HostForLIFE.eu :: Set List Properties By WebRequest

Mar 28th

Posted by Peter in European SharePoint 2013 Hosting

No comments

There are many ways in CSOM to set the list properties of a SharePoint site but there are a few properties which we can’t set directly from list object. In this blog, I will explain how to set those properties using WebRequest, for example: offline client availability, major version limit, and major with minor version limit.

This below-mentioned code sample will help us to set those properties which we cannot access directly from the list object.

The code block for this is as mentioned below,

    using System;  
    using System.Collections.Generic;  
    using System.Linq;  
    using System.Text;  
    using System.Threading.Tasks;  
    using Microsoft.SharePoint.Client;  
    using System.Net;  
    using System.Security;  
    using Microsoft.SharePoint.Client.Utilities;  
    using System.IO;  
    namespace EditListProperties {  
        class EditListPropertiesByWebRequest {  
            public static string HEADER_CONTENT_APP = "application/x-vermeer-urlencoded";  
            public static string USER_AGENT_APP = "FrontPage";  
            public static string MESSAGE_SUCCESS_APP = "message=successfully";  
            public static string MESSAGE_CONFLICT_APP = "msg=Save Conflict";  
            public static string ENABLE_OFFLINE_CLIENT_AVAILABILITY_APP = "&ExcludeFromOfflineClient=False";  
            public static string DISABLE_OFFLINE_CLIENT_AVAILABILITY_APP = "&ExcludeFromOfflineClient=True";  
            public static string MAJOR_VERSION_LIMIT_APP = "&MajorVersionLimit=";  
            public static string MAJOR_VERSION_WITH_MINOR_APP = "&MajorWithMinorVersionsLimit=";  
            static void Main(string[] args) {  
                string listName = "CopyDoc";  
                string username = string.Empty;  
                string password = string.Empty;  
                NetworkCredential credentials = null;  
                List list = null;  
                string query = string.Empty;  
                try {  
                    username = "userName";  
                    password = "******";  
                    ClientContext ctx = new ClientContext("siteUrl"); //creating ClientContext from given SharePoint Site  
                    credentials = new NetworkCredential(username, password); //creating creadential object for SharePoint site.  
                    ctx.Credentials = credentials;  
                    Web web = ctx.Web;  
                    list = ctx.Web.Lists.GetByTitle(listName);  
                    ctx.Load(list, l => l.EnableVersioning);  
                    ctx.ExecuteQuery();  
                } catch (Exception ex) {}  
                try {  
                    //if we want to "SET OFFLINE CLIENT AVAILABILITY"  
                    string value = string.Empty;  
                    value = "Enable"; //We can change it to Enable or Disable accoring to requirement  
                    if (value == "Enable") // if we want it to be enabled  
                    {  
                        query += ENABLE_OFFLINE_CLIENT_AVAILABILITY_APP;  
                    } else if (value == "Disable") // if we want it to be disabled  
                    {  
                        query += DISABLE_OFFLINE_CLIENT_AVAILABILITY_APP;  
                    }  
                    //if we want to "SET MAJOR VERSION LIMIT"  
                    value = string.Empty;  
                    value = "10"; //We can change it to any intiger accoring to requirement  
                    list.EnableVersioning = true;  
                    list.Update();  
                    query += MAJOR_VERSION_LIMIT_APP + value;  
                    //if we want to "SET MAJOR WITH MINOR VERSIONS LIMIT"  
                    value = string.Empty;  
                    value = "5"; //We can change it to any intiger accoring to requirement  
                    list.EnableVersioning = true;  
                    list.Update();  
                    query += MAJOR_VERSION_WITH_MINOR_APP + value;  
                    GetHttpWebRequest(query, credentials);  
                } catch (Exception er) {}  
            }  
            #region GetWebRequest  
            /// <summary>  
            ///  
            /// </summary>  
            /// <param name="query"></param>  
            /// <param name="credential"></param>  
            private static void GetHttpWebRequest(string query, NetworkCredential credential) {  
                try {  
                    HttpWebRequest request = (HttpWebRequest) WebRequest.Create(query);  
                    request.Method = "POST";  
                    request.Headers["Content"] = HEADER_CONTENT_APP;  
                    request.Headers["X-Vermeer-Content-Type"] = HEADER_CONTENT_APP;  
                    request.UserAgent = USER_AGENT_APP;  
                    request.UseDefaultCredentials = false;  
                    request.KeepAlive = true;  
                    request.Credentials = credential;  
                    using(System.IO.Stream requestStream = request.GetRequestStream()) {  
                        GetWebResponse(request);  
                    }  
                } catch (Exception er) {}  
            }  
            #endregion  
            #region GetResponse  
            /// <summary>  
            ///  
            /// </summary>  
            /// <param name="webRequest"></param>  
            /// <returns></returns>  
            private static string GetWebResponse(HttpWebRequest webRequest) {  
                string responseString = string.Empty;  
                using(WebResponse webResponse = webRequest.GetResponse()) {  
                    using(StreamReader reader = new StreamReader(webResponse.GetResponseStream())) {  
                        responseString = reader.ReadToEnd();  
                        byte[] fileBuffer = Encoding.UTF8.GetBytes(responseString);  
                    }  
                }  
                if ((responseString.IndexOf(MESSAGE_SUCCESS_APP) < 0) && (responseString.IndexOf(MESSAGE_CONFLICT_APP) < 0)) {  
                    throw new Exception(responseString);  
                }  
                return responseString;  
            }#endregion  
        }  
    }

100

101

102

103

104

105

106

107

using System;

using System.Collections.Generic;

using System.Linq;

using System.Text;

using System.Threading.Tasks;

using Microsoft.SharePoint.Client;

using System.Net;

using System.Security;

using Microsoft.SharePoint.Client.Utilities;

using System.IO;

namespace EditListProperties {

class EditListPropertiesByWebRequest {

public static string HEADER_CONTENT_APP = "application/x-vermeer-urlencoded";

public static string USER_AGENT_APP = "FrontPage";

public static string MESSAGE_SUCCESS_APP = "message=successfully";

public static string MESSAGE_CONFLICT_APP = "msg=Save Conflict";

public static string ENABLE_OFFLINE_CLIENT_AVAILABILITY_APP = "&ExcludeFromOfflineClient=False";

public static string DISABLE_OFFLINE_CLIENT_AVAILABILITY_APP = "&ExcludeFromOfflineClient=True";

public static string MAJOR_VERSION_LIMIT_APP = "&MajorVersionLimit=";

public static string MAJOR_VERSION_WITH_MINOR_APP = "&MajorWithMinorVersionsLimit=";

static void Main(string[] args) {

string listName = "CopyDoc";

string username = string.Empty;

string password = string.Empty;

NetworkCredential credentials = null;

List list = null;

string query = string.Empty;

try {

username = "userName";

password = "******";

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

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

ctx.Credentials = credentials;

Web web = ctx.Web;

list = ctx.Web.Lists.GetByTitle(listName);

ctx.Load(list, l => l.EnableVersioning);

ctx.ExecuteQuery();

} catch (Exception ex) {}

try {

//if we want to "SET OFFLINE CLIENT AVAILABILITY"

string value = string.Empty;

value = "Enable"; //We can change it to Enable or Disable accoring to requirement

if (value == "Enable") // if we want it to be enabled

{

query += ENABLE_OFFLINE_CLIENT_AVAILABILITY_APP;

} else if (value == "Disable") // if we want it to be disabled

{

query += DISABLE_OFFLINE_CLIENT_AVAILABILITY_APP;

}

//if we want to "SET MAJOR VERSION LIMIT"

value = string.Empty;

value = "10"; //We can change it to any intiger accoring to requirement

list.EnableVersioning = true;

list.Update();

query += MAJOR_VERSION_LIMIT_APP + value;

//if we want to "SET MAJOR WITH MINOR VERSIONS LIMIT"

value = string.Empty;

value = "5"; //We can change it to any intiger accoring to requirement

list.EnableVersioning = true;

list.Update();

query += MAJOR_VERSION_WITH_MINOR_APP + value;

GetHttpWebRequest(query, credentials);

} catch (Exception er) {}

}

#region GetWebRequest

/// <summary>

///

/// </summary>

/// <param name="query"></param>

/// <param name="credential"></param>

private static void GetHttpWebRequest(string query, NetworkCredential credential) {

try {

HttpWebRequest request = (HttpWebRequest) WebRequest.Create(query);

request.Method = "POST";

request.Headers["Content"] = HEADER_CONTENT_APP;

request.Headers["X-Vermeer-Content-Type"] = HEADER_CONTENT_APP;

request.UserAgent = USER_AGENT_APP;

request.UseDefaultCredentials = false;

request.KeepAlive = true;

request.Credentials = credential;

using(System.IO.Stream requestStream = request.GetRequestStream()) {

GetWebResponse(request);

}

} catch (Exception er) {}

}

#endregion

#region GetResponse

/// <summary>

///

/// </summary>

/// <param name="webRequest"></param>

/// <returns></returns>

private static string GetWebResponse(HttpWebRequest webRequest) {

string responseString = string.Empty;

using(WebResponse webResponse = webRequest.GetResponse()) {

using(StreamReader reader = new StreamReader(webResponse.GetResponseStream())) {

responseString = reader.ReadToEnd();

byte[] fileBuffer = Encoding.UTF8.GetBytes(responseString);

}

if ((responseString.IndexOf(MESSAGE_SUCCESS_APP) < 0) && (responseString.IndexOf(MESSAGE_CONFLICT_APP) < 0)) {

throw new Exception(responseString);

}

return responseString;

}#endregion

}

In this blog, I have explained how you can set the properties of a SharePoint list using WebRequest. I hope this information will help you out in a few scenarios.

SharePoint 2013 Hosting Recommendation

HostForLIFE.eu’s SharePoint 2013 Hosting solution offers a comprehensive feature set that is easy-to-use for new users, yet powerful enough for the most demanding web developer expert. Hosted SharePoint Foundation 2013 is the premiere web-based collaboration and productivity enhancement tool on the market today. With SharePoint 2013 Foundation, you can quickly access and manage documents and information anytime, anywhere though a Web browser in a secure and user friendly way. SharePoint hosting services start at only at €9.99/mo, allowing you to take advantage of the robust feature set for a small business price. HostForLIFE.eu offers a variety of hosted SharePoint Foundation 2013 plans as well as dedicated SharePoint 2013 Foundation options

SharePoint 2013 Hosting – HostForLIFE.eu : Getting List Properties From SchemaXml

Mar 21st

Posted by Peter in European SharePoint 2013 Hosting

No comments

There are many ways in CSOM to get the list properties from a SharePoint site. But there are a few properties which we can’t get directly from the list object. In this blog, I will explain how to find those using the SchemaXml.

This below-mentioned code sample will help us to get those properties which we cannot access directly from the list object.

The code block for this is mentioned below.

    using System;  
    using System.Collections.Generic;  
    using System.Linq;  
    using System.Text;  
    using System.Threading.Tasks;  
    using Microsoft.SharePoint.Client;  
    using System.Net;  
    using System.Security;  
    using Microsoft.SharePoint.Client.Utilities;  
    namespace SchemaXml {  
        class GetListSchema {  
            static void Main(string[] args) {  
                string listName = "CopyDoc";  
                string username = string.Empty;  
                string password = string.Empty;  
                SecureString secureString = new SecureString();  
                SharePointOnlineCredentials credentials = null;  
                List list = null;  
                System.Xml.Linq.XDocument xDocument;  
                string modified = string.Empty;  
                try {  
                    username = "userName@domain.com";  
                    password = "******";  
                    foreach(char ch in password.ToCharArray())  
                    secureString.AppendChar(ch);  
                    ClientContext ctx = new ClientContext("siteUrl"); //creating ClientContext from given SharePoint Site  
                    credentials = new SharePointOnlineCredentials(username, secureString); //creating creadential object for office365 site.  
                    ctx.Credentials = credentials;  
                    Web web = ctx.Web;  
                    list = ctx.Web.Lists.GetByTitle(listName);  
                    ctx.Load(list, l => l.SchemaXml, //loading schemaXml  
                        l => l.EnableVersioning);  
                    ctx.ExecuteQuery();  
                } catch (Exception ex) {}  
                try {  
                    using(System.IO.StringReader reader = new System.IO.StringReader(list.SchemaXml)) //getting the data from SchemaXml  
                    {  
                        xDocument = System.Xml.Linq.XDocument.Load(reader); //converting StringReader to XDocument  
                        List < ListpropertiesInfo > listSchemaXml = (from l in xDocument.Descendants("List") select new ListpropertiesInfo // class to store the properties  
                            {  
                                PropMajorVersionLimit = l.Attribute("MajorVersionLimit").Value,  
                                    PropMajorWithMinorVerionLimit = l.Attribute("MajorWithMinorVersionsLimit").Value,  
                                    PropExcludFromOfflineClient = l.Attribute("ExcludeFromOfflineClient").Value,  
                                    PropEnableFolderCreation = l.Attribute("EnableFolderCreation").Value  
                            }).ToList();  
                        foreach(var item in listSchemaXml) {  
                            int majorVersion;  
                            int minorVersion;  
                            if (list.EnableVersioning) {  
                                if (Int32.TryParse(item.PropMajorVersionLimit, out majorVersion)) {  
                                    Console.WriteLine("Major Version: " + majorVersion);  
                                }  
                                if (Int32.TryParse(item.PropMajorWithMinorVerionLimit, out minorVersion)) {  
                                    Console.WriteLine("Minor Version : " + minorVersion);  
                                }  
                            } else {  
                                Console.WriteLine("Major Version: 0");  
                                Console.WriteLine("Minor Version : 0");  
                            }  
                            if (Convert.ToBoolean(item.PropExcludFromOfflineClient)) Console.WriteLine("Status: false");  
                            else Console.WriteLine("Status: true");  
                            Console.WriteLine("Folder Creation: " + item.PropEnableFolderCreation);  
                            Console.ReadLine();  
                        }  
                    }  
                } catch (Exception er) {}  
            }#  
            region ListpropertiesInfo  
            public class ListpropertiesInfo {  
                public string PropMajorVersionLimit {  
                    get;  
                    set;  
                }  
                public string PropMajorWithMinorVerionLimit {  
                    get;  
                    set;  
                }  
                public string PropExcludFromOfflineClient {  
                    get;  
                    set;  
                }  
                public string PropEnableFolderCreation {  
                    get;  
                    set;  
                }  
            }#  
            endregion  
        }  
    }

using System;

using System.Collections.Generic;

using System.Linq;

using System.Text;

using System.Threading.Tasks;

using Microsoft.SharePoint.Client;

using System.Net;

using System.Security;

using Microsoft.SharePoint.Client.Utilities;

namespace SchemaXml {

class GetListSchema {

static void Main(string[] args) {

string listName = "CopyDoc";

string username = string.Empty;

string password = string.Empty;

SecureString secureString = new SecureString();

SharePointOnlineCredentials credentials = null;

List list = null;

System.Xml.Linq.XDocument xDocument;

string modified = string.Empty;

try {

username = "userName@domain.com";

password = "******";

foreach(char ch in password.ToCharArray())

secureString.AppendChar(ch);

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

credentials = new SharePointOnlineCredentials(username, secureString); //creating creadential object for office365 site.

ctx.Credentials = credentials;

Web web = ctx.Web;

list = ctx.Web.Lists.GetByTitle(listName);

ctx.Load(list, l => l.SchemaXml, //loading schemaXml

l => l.EnableVersioning);

ctx.ExecuteQuery();

} catch (Exception ex) {}

try {

using(System.IO.StringReader reader = new System.IO.StringReader(list.SchemaXml)) //getting the data from SchemaXml

{

xDocument = System.Xml.Linq.XDocument.Load(reader); //converting StringReader to XDocument

List < ListpropertiesInfo > listSchemaXml = (from l in xDocument.Descendants("List") select new ListpropertiesInfo // class to store the properties

{

PropMajorVersionLimit = l.Attribute("MajorVersionLimit").Value,

PropMajorWithMinorVerionLimit = l.Attribute("MajorWithMinorVersionsLimit").Value,

PropExcludFromOfflineClient = l.Attribute("ExcludeFromOfflineClient").Value,

PropEnableFolderCreation = l.Attribute("EnableFolderCreation").Value

}).ToList();

foreach(var item in listSchemaXml) {

int majorVersion;

int minorVersion;

if (list.EnableVersioning) {

if (Int32.TryParse(item.PropMajorVersionLimit, out majorVersion)) {

Console.WriteLine("Major Version: " + majorVersion);

}

if (Int32.TryParse(item.PropMajorWithMinorVerionLimit, out minorVersion)) {

Console.WriteLine("Minor Version : " + minorVersion);

}

} else {

Console.WriteLine("Major Version: 0");

Console.WriteLine("Minor Version : 0");

}

if (Convert.ToBoolean(item.PropExcludFromOfflineClient)) Console.WriteLine("Status: false");

else Console.WriteLine("Status: true");

Console.WriteLine("Folder Creation: " + item.PropEnableFolderCreation);

Console.ReadLine();

}

} catch (Exception er) {}

region ListpropertiesInfo

public class ListpropertiesInfo {

public string PropMajorVersionLimit {

get;

set;

}

public string PropMajorWithMinorVerionLimit {

get;

set;

}

public string PropExcludFromOfflineClient {

get;

set;

}

public string PropEnableFolderCreation {

get;

set;

}

endregion

}

In this blog, I have explained how you can get the properties of a SharePoint list from SchemaXml. I hope this information will help you out in a few scenarios.

SharePoint 2013 Hosting Recommendation

Sharepoint 2013 Hosting – HostForLIFE.eu :: How To Create Structural Navigation Nodes In Quick Launch And Top Navigation?

Mar 14th

Posted by Peter in European SharePoint 2013 Hosting

No comments

You can add, edit, or remove links on the left-hand menu (Quick Launch menu), the top menu (Top Navigation Node) through “Edit Links” in SharePoint. In this blog, we are going to create a structural navigation node that is the root node having subnodes in both – top navigation and quick launch.

The code block for this is mentioned below.

    using System;  
    using System.Linq;  
    using System.Security;  
    using Microsoft.SharePoint.Client;  
    namespace StructuralNavigationNode {  
        class Program {  
            static void Main(string[] args) {  
                ClientContext ctx = new ClientContext("http://portal/sites/site1");  
                string password = "Password";  
                SecureString secureString = new SecureString();  
                foreach(char c in password.ToCharArray()) secureString.AppendChar(c);  
                ctx.Credentials = new SharePointOnlineCredentials("user@domain.com", secureString);  
                ctx.ExecuteQuery();  
                Web web = ctx.Web;  
                NavigationNodeCollection quickLaunchNodeColl = web.Navigation.QuickLaunch; // we are getting all quick launch node collection  
                NavigationNodeCollection topNavNodeColl = web.Navigation.TopNavigationBar; // we are getting all top navigation node collection  
                NavigationNodeCreationInformation quickLaunchNodeCreation = new NavigationNodeCreationInformation();  
                quickLaunchNodeCreation.Title = "QuickLaunchNode";  
                quickLaunchNodeCreation.Url = "http://www.softreeconsulting.com/";  
                quickLaunchNodeColl.Add(quickLaunchNodeCreation); //we are creating root quick launch node  
                ctx.Load(quickLaunchNodeColl);  
                ctx.ExecuteQuery();  
                NavigationNode quickLaunchParentNode = quickLaunchNodeColl.Where(n => n.Title == "QuickLaunchNode").FirstOrDefault(); //retrieving parent quick launch root node for which we will add sub nodes  
                NavigationNodeCreationInformation quickLaunchNodeCreationInformation = new NavigationNodeCreationInformation();  
                quickLaunchNodeCreationInformation.Title = "QuickLaunchSubNode";  
                quickLaunchNodeCreationInformation.Url = "http://www.softreeconsulting.com/about-us/";  
                quickLaunchParentNode.Children.Add(quickLaunchNodeCreationInformation); //we are creating sub quicklaunch node  
                quickLaunchParentNode.Update();  
                ctx.ExecuteQuery();  
                NavigationNodeCreationInformation topNavNodeCreation = new NavigationNodeCreationInformation();  
                topNavNodeCreation.Title = "TopNavNode";  
                topNavNodeCreation.Url = "http://www.softreeconsulting.com/";  
                topNavNodeColl.Add(topNavNodeCreation); //we are creating root top navigation node  
                ctx.Load(topNavNodeColl);  
                ctx.ExecuteQuery();  
                NavigationNode topNavParentNode = topNavNodeColl.Where(n => n.Title == "TopNavNode").FirstOrDefault(); //retrieving parent top navigation root node for which we will add sub nodes  
                NavigationNodeCreationInformation topNavNodeCreationInformation = new NavigationNodeCreationInformation();  
                topNavNodeCreationInformation.Title = "TopNavSubNode";  
                topNavNodeCreationInformation.Url = "http://www.softreeconsulting.com/about-us/";  
                topNavParentNode.Children.Add(topNavNodeCreationInformation); //we are creating sub top navigation node  
                topNavParentNode.Update();  
                ctx.ExecuteQuery();  
            }  
        }  
    }

using System;

using System.Linq;

using System.Security;

using Microsoft.SharePoint.Client;

namespace StructuralNavigationNode {

class Program {

static void Main(string[] args) {

ClientContext ctx = new ClientContext("http://portal/sites/site1");

string password = "Password";

SecureString secureString = new SecureString();

foreach(char c in password.ToCharArray()) secureString.AppendChar(c);

ctx.Credentials = new SharePointOnlineCredentials("user@domain.com", secureString);

ctx.ExecuteQuery();

Web web = ctx.Web;

NavigationNodeCollection quickLaunchNodeColl = web.Navigation.QuickLaunch; // we are getting all quick launch node collection

NavigationNodeCollection topNavNodeColl = web.Navigation.TopNavigationBar; // we are getting all top navigation node collection

NavigationNodeCreationInformation quickLaunchNodeCreation = new NavigationNodeCreationInformation();

quickLaunchNodeCreation.Title = "QuickLaunchNode";

quickLaunchNodeCreation.Url = "http://www.softreeconsulting.com/";

quickLaunchNodeColl.Add(quickLaunchNodeCreation); //we are creating root quick launch node

ctx.Load(quickLaunchNodeColl);

ctx.ExecuteQuery();

NavigationNode quickLaunchParentNode = quickLaunchNodeColl.Where(n => n.Title == "QuickLaunchNode").FirstOrDefault(); //retrieving parent quick launch root node for which we will add sub nodes

NavigationNodeCreationInformation quickLaunchNodeCreationInformation = new NavigationNodeCreationInformation();

quickLaunchNodeCreationInformation.Title = "QuickLaunchSubNode";

quickLaunchNodeCreationInformation.Url = "http://www.softreeconsulting.com/about-us/";

quickLaunchParentNode.Children.Add(quickLaunchNodeCreationInformation); //we are creating sub quicklaunch node

quickLaunchParentNode.Update();

ctx.ExecuteQuery();

NavigationNodeCreationInformation topNavNodeCreation = new NavigationNodeCreationInformation();

topNavNodeCreation.Title = "TopNavNode";

topNavNodeCreation.Url = "http://www.softreeconsulting.com/";

topNavNodeColl.Add(topNavNodeCreation); //we are creating root top navigation node

ctx.Load(topNavNodeColl);

ctx.ExecuteQuery();

NavigationNode topNavParentNode = topNavNodeColl.Where(n => n.Title == "TopNavNode").FirstOrDefault(); //retrieving parent top navigation root node for which we will add sub nodes

NavigationNodeCreationInformation topNavNodeCreationInformation = new NavigationNodeCreationInformation();

topNavNodeCreationInformation.Title = "TopNavSubNode";

topNavNodeCreationInformation.Url = "http://www.softreeconsulting.com/about-us/";

topNavParentNode.Children.Add(topNavNodeCreationInformation); //we are creating sub top navigation node

topNavParentNode.Update();

ctx.ExecuteQuery();

}

Output

After the code is executed, you can see the root navigation with its respective subnodes created successfully.

SharePoint 2013 Hosting Recommendation

Posts tagged trick SharePoint 2013 Hosting

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

SharePoint 2013 Hosting – HostForLIFE.eu :: SharePoint Search Application Returns “The Content Processing Pipeline Failed To Process The Item” Error On Crawl

SharePoint 2013 Hosting – HostForLIFE.eu :: Set List Properties By WebRequest

SharePoint 2013 Hosting Recommendation

SharePoint 2013 Hosting – HostForLIFE.eu : Getting List Properties From SchemaXml

SharePoint 2013 Hosting Recommendation

Sharepoint 2013 Hosting – HostForLIFE.eu :: How To Create Structural Navigation Nodes In Quick Launch And Top Navigation?

SharePoint 2013 Hosting Recommendation

BLOGROLL

Featured On

Posts tagged trick SharePoint 2013 Hosting

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

SharePoint 2013 Hosting – HostForLIFE.eu :: SharePoint Search Application Returns “The Content Processing Pipeline Failed To Process The Item” Error On Crawl

SharePoint 2013 Hosting – HostForLIFE.eu :: Set List Properties By WebRequest

SharePoint 2013 Hosting Recommendation

SharePoint 2013 Hosting – HostForLIFE.eu : Getting List Properties From SchemaXml

SharePoint 2013 Hosting Recommendation

Sharepoint 2013 Hosting – HostForLIFE.eu :: How To Create Structural Navigation Nodes In Quick Launch And Top Navigation?

SharePoint 2013 Hosting Recommendation

BLOGROLL

Featured On

Tags