Introduction
Welcome to the SharePoint 2013 REST Series. In my previous article, we saw how to add an attachment to the list item in the SharePoint 2013 REST API.
In this article, we will discuss how to remove an attachment from list items in a SharePoint List using the REST API.
The SharePoint 2013 environment adds the ability 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 gives 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 End Points
The following is a list of End points which 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.
Tenant |
Full Permission |
Site Collection |
Full Permission |
Web |
Full Permission |
List |
Full Permission |
Step 2: Navigate to the App.js file then copy the following code and paste it in.
Code
- 'use strict';
- var hostweburl;
- var appweburl;
-
-
-
- $(document).ready(function () {
-
-
- hostweburl =
- decodeURIComponent(
- getQueryStringParameter("SPHostUrl"));
- appweburl =
- decodeURIComponent(
- getQueryStringParameter("SPAppWebUrl"));
-
-
- var scriptbase = hostweburl + "/_layouts/15/";
-
-
-
-
-
- $.getScript(scriptbase + "SP.RequestExecutor.js", execCrossDomainRequest);
- });
-
-
-
- function execCrossDomainRequest() {
-
-
- var executor = new SP.RequestExecutor(appweburl);
- var digest = $("#__REQUESTDIGEST").val();
-
-
-
-
-
-
- executor.executeAsync(
- {
- url:
- appweburl +
- "/_api/SP.AppContextSite(@target)/web/lists/getbytitle('CustomList')/items(1)/AttachmentFiles/getbyFileName('mycustom.txt')?@target='" +
- hostweburl + "'",
- method: "DELETE",
- data: metatdata ,
- headers: {
- "X-RequestDigest": digest, "Accept": "application/json; odata=verbose"},
- success: function (data) {
- alert("success: " + JSON.stringify(data));
- },
- error: function (err) {
- alert("error: " + JSON.stringify(err));
- }
- }
- );
- }
-
-
-
-
-
-
-
-
- function getQueryStringParameter(paramToRetrieve) {
- var params =
- document.URL.split("?")[1].split("&");
- for (var i = 0; i < params.length; i = i + 1) {
- var singleParam = params[i].split("=");
- if (singleParam[0] == paramToRetrieve)
- return singleParam[1];
- }
- }
-
-
- function contextSuccessHandler(data) {
- alert("List Created Successfully");
- }
-
- function contextErrorHandler(data, errorCode, errorMessage) {
- alert(data);
- alert(errorCode);
- alert("Could not get context info: " + errorMessage);
- }
Screenshot
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
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.
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.
- function execCrossDomainRequest() {
-
-
- var executor = new SP.RequestExecutor(appweburl);
Output
Summary
I hope this article helps you.