Check Out Files in SharePoint Library 2013 Using REST API

In this article, we will discuss how to check out files in a SharePoint Document Library using the REST API.

Introduction

Welcome to the SharePoint 2013 REST Series. In my previous article, we saw how to Get Site Group Details Using SharePoint 2013 REST API.

In this article, we will discuss how to check out files in a SharePoint Document Library using the REST API.

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 give you entry into granular access points.

  1. Site

    http://server/site/_api/site
     
  2. Web

    http://server/site/_api/web
     
  3. User Profile

    http:// server/site/_api/SP.UserProfiles.PeopleManager
     
  4. Search

    http:// server/site/_api/search
     
  5. Publishing

    http:// server/site/_api/publishing

List of REST End Points

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 that you sufficient permission to access cross-domain requests. So I have given full permission to all the contents listed below.

Tenant

Full Permission

Site Collection

Full Permission

Web

Full Permission

List

Full Permission

 Permission

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.     // This code runs when the DOM is ready and creates a context object which is   
  6.     // needed to use the SharePoint object model  
  7.     $(document).ready(function () {  
  8.           
  9.             //Get the URI decoded URLs.   
  10.     hostweburl =   
  11.         decodeURIComponent(   
  12.             getQueryStringParameter("SPHostUrl"));   
  13.     appweburl =   
  14.         decodeURIComponent(   
  15.             getQueryStringParameter("SPAppWebUrl"));   
  16.                // Resources are in URLs in the form:  
  17.         // web_url/_layouts/15/resource  
  18.         var scriptbase = hostweburl + "/_layouts/15/";    
  19.    
  20.         // Load the js file and continue to load the page with information about the list top level folders.  
  21.         // SP.RequestExecutor.js to make cross-domain requests  
  22.           
  23.          // Load the js files and continue to the successHandler  
  24.             $.getScript(scriptbase + "SP.RequestExecutor.js", execCrossDomainRequest);  
  25.              });  
  26.               
  27.              // Function to prepare and issue the request to get  
  28.           //  SharePoint data  
  29.           function execCrossDomainRequest() {  
  30.             // executor: The RequestExecutor object  
  31.             // Initialize the RequestExecutor with the app web URL.  
  32.             var executor = new SP.RequestExecutor(appweburl);             
  33.   
  34.             var metatdata = "{ '__metadata': { 'type': 'SP.Data.TestListListItem' }, 'Title': 'changelistitemtitle'}";  
  35.   
  36.             // Issue the call against the app web.  
  37.             // To get the title using REST we can hit the endpoint:  
  38.             //      appweburl/_api/web/lists/getbytitle('listname')/items  
  39.             // The response formats the data in the JSON format.  
  40.             // The functions successHandler and errorHandler attend the  
  41.             //      sucess and error events respectively.  
  42.             executor.executeAsync(  
  43.                 {           
  44.           url:   
  45.             appweburl +   
  46.             "/_api/SP.AppContextSite(@target)/web/ GetFileByServerRelativeUrl(  
  47.   '/Shared Documents/a.txt')/CheckOut()?@target='" +   
  48.             hostweburl + "'",   
  49.         method: "POST",   
  50.         body: metatdata ,   
  51.         headers: { "Accept""application/json; odata=verbose""content-type""application/json; odata=verbose""content-length": metatdata.length, "X-HTTP-Method""MERGE""IF-MATCH""*" },           
  52.             success: function (data) {  
  53.                 alert("success: " + JSON.stringify(data));  
  54.             },  
  55.             error: function (err) {  
  56.                 alert("error: " + JSON.stringify(err));  
  57.             }   
  58.                 }           
  59.             );               
  60.               
  61.           }                   
  62.     // This function prepares, loads, and then executes a SharePoint query to get   
  63.     // the current users information       
  64. //Utilities   
  65.    
  66. // Retrieve a query string value.   
  67. // For production purposes you may want to use   
  68. // a library to handle the query string.   
  69. function getQueryStringParameter(paramToRetrieve) {   
  70.     var params =   
  71.         document.URL.split("?")[1].split("&");     
  72.     for (var i = 0; i < params.length; i = i + 1) {   
  73.         var singleParam = params[i].split("=");   
  74.         if (singleParam[0] == paramToRetrieve)   
  75.             return singleParam[1];   
  76.     }   
  77. }  

Screenshot

Screenshot
code

Step 3: When deploying, you will be prompted with the following screen. Press Trust it and proceed with the deployment.

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. // executor: The RequestExecutor object  
  3. // Initialize the RequestExecutor with the app web URL.  
  4. var executor = new SP.RequestExecutor(appweburl); var metatdata = "{ '__metadata': { 'type': 'SP.Data.TestListListItem' }, 'Title': 'changelistitemtitle'}"

Summary

I hope this article helps you.