Skip to main content

REST operations in SharePoint 2013

REST operations are essential in any SharePoint development. This series explain available REST endpoints in SharePoint 2013. First article shows how we can made a REST call in both SharePoint Hosted and Provider Hosted app.

Executing a REST GET call from SharePoint Provider Hosted App

First you need to refer related JavaScript related.

<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
<script type="text/javascript" src="#SPWeb/_layouts/15/MicrosoftAjax.js"></script>
<script type="text/javascript" src="#SPWeb/_layouts/1033/init.js"></script>
<script type="text/javascript" src="#SPWeb/_layouts/15/sp.core.js"></script>
<script type="text/javascript" src="#SPHost/_layouts/15/SP.RequestExecutor.js"></script>
<script type="text/javascript" src="#SPWeb/_layouts/15/sp.js"></script>


You need to replace the #SPWeb from Appweb Url and #SPHost from Host web Url. App Web Url and Host Web Url is available in Url.



You can find these parameters as QueryString and available in SPAppWebUrl, SPHostUrl.



You need to specify the AppWebUrlUrl in the method below. If you are good at jQuery you can change the method by introducing Deferred Object.




 

function getREST(url,success,fail){
 
  // specify your web app url here
  // EX- https://oapp.sharepoint.com/sites/AWM/ArtWorkManagement
  var AppWebUrlUrl = "";  
  var executor = new SP.RequestExecutor(AppWebUrlUrl);
 
  executor.executeAsync(
       {
           url: AppWebUrlUrl + url,
           method: "GET", 
           contentType: "application/json;odata=verbose",
           headers: { "Accept": "application/json; odata=verbose" },
           success: function (data) {
               if(success){success(data);} // call the function if done
           },
           error: function (data, errorCode, errorMessage) {
               if(fail){fail(data);} // call the function if done
           }
       }
);
}


Executing a REST GET call from SharePoint Hosted App



You need to specify the AppWebUrlUrl in the method below.




 

function getREST(url,success,fail){
 
  // specify your web app url here
  // EX- https://oapp.sharepoint.com/sites/AWM/ArtWorkManagement
  var AppWebUrlUrl = "";  
 
    $.ajax({
            method: "GET",
            url: AppWebUrlUrl + url,
            success: function (data) {
                if(success){success(data);} // call the function if done
 
            },
            error: function (data) {
                if(fail){fail(data);} // call the function if done
            }
        });
 }


Calling the Function




 

function done(data){
  // success
}
 
function error(){
    // Error
}
 
var restUrl = "" // Your URL goes here
getREST(restUrl,done,error);
 
 
Labels:

Comments

Post a Comment

Popular posts from this blog

How to Link Two List and Create a combine view in the SharePoint 2010

In this way you can join multiple list together and can create a combine view. for an example assume that you are managing a list for some events. And also you are having a participants in separate list. Thus you want to join the two list and create a composite view. SharePoint 2010 allows you to create this kind of view using  Linked Data Source. in this approach you can create your own custom list in the SharePoint. How to Create a Linked Data source Go to SharePoint designer and  go to the link called data sources. And Click the Linked Data Source button in the ribbon. Then SharePoint designer will prompt following kind of a dialog. In there add two list, that you wan to linked together. I'm adding airline schedule and booking list. those are the two list that i wan to merge. then click next. And it will guide you another screen. it will ask you to select either Merge Merge use to combine list which are having same columns definition. for and example we can s...
32 comments
Read more

How to Improve Workflow Performance in SharePoint Server 2010

SharePoint workflows are getting  slow for several reasons. in my environment I'm having a problem with following performance issues, therefore in my environment i got following problems. When a item added to the library it takes some times to initiate the workflow. Workflow mail generating is not very fast sometimes. Workflows takes more time to process “Due to heavy load, the latest workflow operation has been queued. It will attempt to resume at a later time” is coming sometimes. I had a custom workflow approval web part and it is taking more than 30 seconds to proceed. Work Done I had a custom workflow approval web part and it is taking more than 30 seconds to proceed. here in my custom web part there is the function which is programmatically updating the workflow. SPWorkflowTask.AlterTask(item, data, false) the last parameter mentioning whether it is synchronous asynchronous. if  is it true it it will wait until workflow schedule accept the workflow task. ...
5 comments
Read more

How to Customize New Item Form to take parameters from Query String in the SharePoint 2010

In here I'm going to explain how to customize the SharePoint Item From to take parameters from Query String and set them as default values using SharePoint designer. Using this you can open a new Item From by providing parameters as query string. For an example you can customize one item Display form and taking query String Parameter from that and view New Item view for another list by providing default values using the Query String.     Steps Open the SharePoint designer and go to list and libraries and open the list that you want. Click the New and create a New Insert View by providing the name of the view.   Then created one will come to the list. then click and open the view. Then default New Item Screen will be loaded as follows. Then Delete the default list view and make that empty. You can delete the controls by selecting the area in the design view, If it fully cleared you can view the following message from the designer. Then go to SharePoint...
6 comments
Read more