Skip to main content

Send items to Recycle Bin using REST

When we have to implement Delete operation using REST API, we normally use the straightforward method to delete an item or a document. For example, to delete an item from a List, we use the following code.

$.ajax({ 
 type: "POST", 
 url: _spPageContextInfo.webAbsoluteUrl + "/_api/web/lists/getByTitle('CustomList')/items(2)", 

 headers: { 
   "accept": "application/json; odata=verbose",
     "X-HTTP-METHOD": "DELETE",
     "IF-MATCH": "*",
     "X-RequestDigest": $("#__REQUESTDIGEST").val()
 },

 success: function(data){
     alert("Item is deleted!");
 },
 error: function(error){
     alert("Error"); console.log(error);
 }

});

To delete a document from a Library, we use the below code.

$.ajax({ 
 type: "POST", 
 url: _spPageContextInfo.webAbsoluteUrl + "/_api/web/getfilebyserverrelativeurl('/sites/pub/Documents/DocIcon.png')", 

  headers: { 
     "accept": "application/json; odata=verbose", 
     "X-HTTP-METHOD": "DELETE", 
     "IF-MATCH": "*", 
     "X-RequestDigest": $("#__REQUESTDIGEST").val() 
 }, 

  success: function(data){ 
     alert("Document is deleted!"); 
 }, 
 error: function(error){ 
     alert("Error"); console.log(error); 
 } 

 });

However, have you observed when a user deletes an item or a document from SharePoint UI, the deleted item is sent to Recycle Bin. So that, the user will get an option to restore the deleted item. But if we use the above approach, the deleted item will be permanently deleted and user will not get an option to restore.

So how do we mimic the out-of-the-box behavior through program?

SharePoint provides another endpoint called Recycle, with which we can send the deleted item to Recycle bin. Let's have a look at this method.

The code to recycle an item from a List:

$.ajax({ 
 type: "POST", 
 url: _spPageContextInfo.webAbsoluteUrl + "/_api/web/lists/getByTitle('CustomList')/items(3)/recycle()", 
 headers: { 
     "accept": "application/json; odata=verbose", 
     "IF-MATCH": "*", 
     "X-RequestDigest": $("#__REQUESTDIGEST").val() 
 }, 
 success: function(data){ 
     alert("Item is recycled!"); 
 }, 
 error: function(error){ 
     alert("Error"); console.log(error); 
 } 

 });

The code to recycle a document:

$.ajax({ 
 type: "POST", 
 url: _spPageContextInfo.webAbsoluteUrl + "/_api/web/getfilebyserverrelativeurl('/sites/pub/Documents/DocIcon.png')/recycle()", 

 headers: { 
     "accept": "application/json; odata=verbose", 
     "IF-MATCH": "*", 
     "X-RequestDigest": $("#__REQUESTDIGEST").val() 
 }, 

 success: function(data){ 
     alert("Document is recycled!"); 
 }, 
 error: function(error){ 
     alert("Error"); console.log(error); 
 } 

 });

You can also recycle item attachment and in this case you need to use another method RecycleObject, as shown below.
However do note that this method is not available in SharePoint 2013 on-prem environment. The below code works in SharePoint Online.

$.ajax({ 
 method: "DELETE", 
 url: _spPageContextInfo.webAbsoluteUrl + "/_api/web/lists/getByTitle('CustomList')/getItemById(1)/AttachmentFiles/getByFileName('TestDoc.txt')/RecycleObject", 

  headers: 
    {"X-RequestDigest": $("#__REQUESTDIGEST").val()
 }, 

  success: function(data){ 
     alert("File is deleted successfully"); 
 }, 

  error: function(error){ 
     alert("Error in deleting attachment"); console.log(error); 
 } 

 });

As shown above, you can use Recycle method to allow users to restore items in case they are deleted accidentally. I've not verified if RecycleObject is available in SharePoint 2016 on-prem. If I get a chance to validate, will update my findings here.
Labels:

Comments

Post a Comment

Popular posts from this blog

All about SharePoint List View Styles

Sometimes, there are out of the box features which we tend to ignore and later when we do apply, we are more than happy about the feature which is readily available in SharePoint. One such feature is List View Style. I never thought I would write a post on this. However, whenever I spoke about this with users, people were excited to see the result. That prompted me to write this post. Instead of getting into only theory part, I will basically take use cases where these styles can be applied and also touch up on on some minor limitations with certain style. When you are creating/modifying a List view, you will get an option to select View Style. As shown below, there are 8 options available and Default is always set if you ignore this style. List of View Styles I will take typical Contact List and Announcement List to explian about these styles. Let us go one by one. Default: This view, as name suggest, is the default style in a view. This is one of the widely seen style ...
1 comment
Read more

How to update Person field with multiple values using REST API

Person or Group field in SharePoint is similar to a Lookup field. When you are updating this field using REST API, you need to append "Id" to the name of the column in the body construct. For example, the body construct looks like this: data: { "__metadata": { "type": "SP.Data. ListName ListItem" }, "Title": "First Item", " PeopleField Id": "4" }; The highlighted portions should be replaced by the actual List Name and Column Name. In the above example, the REST call is updating a List item with Title and People columns. How to get the value for user ID ("4" in the above example) needs a separate explanation and that will be my next post! The above example works fine if Person field is configured to accept only one value. If we change the Person field to accept multiple values, how do we pass more than one value in the REST call? Since we normally separate user names with semicolon in peop...
12 comments
Read more

How to get SharePoint List or Library GUID via REST

Sometimes, you would need List or Library GUID to use that in some operation. In such cases, how do you get hold of GUID using REST API? There is a straight-forward end point which you can use: /_api/web/lists/getByTitle('ListTitle')/Id This will return the GUID of a List or Library. There is also another approach. However this approach works only if a List or Library contains at least one item. /_api/web/lists/getByTitle('ListTitle')/items This is a familiar end point which we use to fetch items of a List or Library. To get the GUID from the response, you would do: var listIDTemp = response.data.d.results[0].__metadata.id; var listID = listIDTemp.substring(listIDTemp.lastIndexOf("guid") + 5).split('\'')[0]; As you can see, we are doing string operations to fetch GUID from metadata.id. This contains information only if the response has at least one item.
Post a Comment
Read more