Introduction
Welcome to the SharePoint 2013 REST Series. In my previous article, we saw how to get the User Custom Actions in SharePoint site 2013 using the REST API.
This article explains how to get the event receivers attached to a SharePoint site.
The SharePoint 2013 environment adds the ability for you to remotely interact with SharePoint sites using REST. So you can talk to SharePoint objects using any technology that supports standard REST capabilities. In this way, SharePoint data can be accessed anywhere and everywhere.
List of REST Access Points
The following is a list of access points that provide you entry into granular access points.
- Site
http://server/site/_api/site
- Web
http://server/site/_api/web
- User Profile
http:// server/site/_api/SP.UserProfiles.PeopleManager
- Search
http:// server/site/_api/search
- Publishing
http:// server/site/_api/publishing
List of REST Endpoints
The following is a list of endpoints that are the most commonly used in a SharePoint list.
- http://server/site/_api/web/lists
- http://server/site/_api/lists/getbytitle('listname')
- http://server/site/_api/web/lists(‘guid’)
- http://server/site/_api/web/lists/getbytitle(‘Title’)
Note: The following code is tested in my SP 2013 online environment.
Step 1: Before writing your code, please ensure you have sufficient permission to access cross-domain requests. So I have given full permission to all the contents listed below.
Step 2: Navigate to the App.js file and copy the following code and paste it in.
Code
- 1. 'use strict';
- 2. var hostweburl;
- 3. var appweburl;
- 4.
- 5.
- 6.
- 7. $(document).ready(function () {
- 8.
- 9.
- 10. hostweburl =
- 11. decodeURIComponent(
- 12. getQueryStringParameter("SPHostUrl"));
- 13. appweburl =
- 14. decodeURIComponent(
- 15. getQueryStringParameter("SPAppWebUrl"));
- 16.
- 17.
- 18. var scriptbase = hostweburl + "/_layouts/15/";
- 19.
- 20.
- 21.
- 22.
- 23.
- 24. $.getScript(scriptbase + "SP.RequestExecutor.js", execCrossDomainRequest);
- 25. });
- 26.
- 27.
- 28.
- 29. function execCrossDomainRequest() {
- 30.
- 31.
- 32. var executor = new SP.RequestExecutor(appweburl);
-
- 33.
- 34.
- 35.
- 36.
- 37.
- 38.
- 39. executor.executeAsync(
- 40. {
- 41. url:
- 42.
- 43. appweburl +
- 44.
- 45. "/_api/SP.AppContextSite(@target)/web/ EventReceivers? @target='" +
- 46. hostweburl + "'",
- 47. method: "POST",
- 48. data: "{ 'logonName': 'i:0#.f|membership|[email protected]' }",
- 49.
- 50.
-
- 51. headers: { "Accept": "application/json; odata=verbose" },
- 52. success: function (data) {
- 53. alert("success: " + JSON.stringify(data));
- 54. error: function (err) {
- 55. alert("error: " + JSON.stringify(err));
- 56. }
-
- 57. }
-
- 58. );
-
- 59. }
-
- 60.
- 61.
- 62.
- 63.
- 64.
- 65.
- 66.
- 67.
- 68. function getQueryStringParameter(paramToRetrieve) {
- 69. var params =
- 70. document.URL.split("?")[1].split("&");
- 71. for (var i = 0; i < params.length; i = i + 1) {
- 72. var singleParam = params[i].split("=");
- 73. if (singleParam[0] == paramToRetrieve)
- 74. return singleParam[1];
- 75. }
- 76. }
Step 3: When deploying, you will be prompted with the following screen. Press Trust it and proceed with the deployment.
Code Walkthrough
A. Post Method in REST API
The SharePoint 2013 REST service supports sending POST commands that include object definitions to endpoints that represent collections. In this example, Test List is a custom SharePoint list where list items are updated.
IF-MATCH header
Provides a way to verify that the object being changed has not been changed since it was last retrieved. Or, lets you specify to overwrite any changes, as shown in the following example: "IF-MATCH":"*".
B. Request Executor.JS
The cross-domain library lets you interact with more than one domain in your remote app page through a proxy. SP.RequestExecutor.js acts as a cross-domain library to fetch or create a SharePoint list from your APP domain.
- 1. function execCrossDomainRequest() {
- 2.
- 3.
- 4. var executor = new SP.RequestExecutor(appweburl); var metatdata = "{ '__metadata': { 'type': 'SP.Data.TestListListItem' }, 'Title': 'changelistitemtitle'}";
Summary
I hope this article helps you.