Update folder name using REST API

Question

I am using REST to update folder name via sharepoint apps. My code as follows:

executor = new SP.RequestExecutor(appweburl);
executor.executeAsync({
        url: appweburl + "/_api/SP.AppContextSite(@target)/web/GetFolderByServerRelativeUrl('" + libraryToSearch + "/" + oldFolderName +"')?@target='" + mysiteUrl + "'";
        headers: {
            Accept: "application/json;odata=verbose",
            "content-type": "application/json;odata=verbose",
            "X-HTTP-Method": "MERGE",
            "IF-MATCH":"*"
        },
        method: "POST",
        body: '{ "__metadata": { "type": "SP.Folder" }, "Name": "Test Update" }',        
        success: FolderNameUpdateSuccess,
        error: FolderNameUpdateFailure
    });

Finally it is coming to the success block, but folder name is not updating... I searched for long time but no result. What could be the problem here? In success block data is retreiving like below.

Status Text comes out as "No Content", what does it mean?

Answer 1

SP.Folder.name property is read-only and hence it could not be used in update operation.

How to rename Folder using SharePoint 2013 REST

The following example demonstrates how to rename Folder using SharePoint 2013 REST API:

function executeJson(url,method,additionalHeaders,payload) 
{
    var headers = {};
    headers["Accept"] = "application/json;odata=verbose";
    if(method == "POST") {
        headers["X-RequestDigest"] = $("#__REQUESTDIGEST").val();
    }   
    if (typeof additionalHeaders != 'undefined') {
        for(var key in additionalHeaders){
            headers[key] = additionalHeaders[key];
        }    
    }    

    var ajaxOptions = 
    {       
       url: url,   
       type: method,  
       contentType: "application/json;odata=verbose",
       headers: headers
    };
    if(method == "POST") {
      ajaxOptions.data = JSON.stringify(payload);
    }  

    return $.ajax(ajaxOptions);
}

function renameFolder(webUrl,folderUrl,name)
{
     var folderItemUrl =  webUrl + "/_api/web/GetFolderByServerRelativeUrl('" + folderUrl + "')/ListItemAllFields";
     return executeJson(folderItemUrl,"GET").then(
         function(data){         
             var itemPayload = {};
             itemPayload['__metadata'] = {'type': data.d['__metadata']['type']};
             itemPayload['Title'] = name;
             itemPayload['FileLeafRef'] = name;
             var itemUrl = data.d['__metadata']['uri'];
             var additionalHeaders = {};
             additionalHeaders["X-HTTP-Method"] = "MERGE";
             additionalHeaders["If-Match"] =  "*";
             return executeJson(itemUrl,"POST",additionalHeaders,itemPayload);
         });
}

Usage

How to rename folder named 2014 located under Documents library to Archive:

renameFolder(_spPageContextInfo.webAbsoluteUrl,'/Shared Documents/2014','Archive')
.done(function()
{
    console.log('Folder has been renamed');
})
.fail(
function(error){
    console.log(JSON.stringify(error));
});

Update

How to rename Folder using SharePoint 2013 REST (ver 2)

function renameFolder(webUrl,listTitle,itemId,name)
{
     var itemUrl =  webUrl + "/_api/Web/Lists/GetByTitle('" + listTitle + "')/Items(" + itemId + ")";
     var itemPayload = {};
     itemPayload['__metadata'] = {'type': getItemTypeForListName(listTitle)};
     itemPayload['Title'] = name;
     itemPayload['FileLeafRef'] = name;
     var additionalHeaders = {};
     additionalHeaders["X-HTTP-Method"] = "MERGE";
     additionalHeaders["If-Match"] =  "*";
     return executeJson(itemUrl,"POST",additionalHeaders,itemPayload);
}


function getItemTypeForListName(name) {
   return"SP.Data." + name.charAt(0).toUpperCase() + name.slice(1) + "ListItem";
}