REST APi to get all times in specific folder in SharePoint document library

6
votes

I would like to get items in specific folder inside SharePoint document library called "Pages" with REST API

I used below rest API which I can get all items in document library
https://spsite/_api/web/lists/getByTitle('Pages')/items

But I have not found the REST api which I can get all times in specific folder inside SharePoint document library

3
restsharepointoffice365apisharepointdocumentlibrary
What do you mean by "get all times", can you elaborate? – Vadim Gremyachev
get all items under the specific folder in the document libarray, for example I have document library called "Pages" under this library I have folder called "Test" I want to get all items under "Test" folder – Laleh

3 Answers

8
votes

There are at least two options available to return items from a specific folder:

1) Using /_api/web/getfolderbyserverrelativeurl('<serverrelativefolderurl>') endpoint

The following example returns all the files along with associated list items from a specific folder:

/_api/web/getfolderbyserverrelativeurl('<serverrelativefolderurl>')/files?$expand=ListItemAllFields

2) using FolderServerRelativeUrl property of CAML query

function getListItems(webUrl,listTitle, queryText,folderUrl) 
{
    var viewXml = '<View><Query>' + queryText + '</Query></View>';
    var url = webUrl + "/_api/web/lists/getbytitle('" + listTitle + "')/getitems"; 
    var queryPayload = {  
               'query' : {
                      '__metadata': { 'type': 'SP.CamlQuery' }, 
                      'ViewXml' : viewXml,
                      "FolderServerRelativeUrl": folderUrl 
               }
    };

    return $.ajax({
           url: url,
           method: "POST",
           data: JSON.stringify(queryPayload),
           headers: {
              "X-RequestDigest": $("#__REQUESTDIGEST").val(),
              "Accept": "application/json; odata=verbose",
              "content-type": "application/json; odata=verbose"
           }
     });
}

Usage

getListItems(_spPageContextInfo.webAbsoluteUrl,'Pages', '', '/Pages/Archive')
.then(function(data)
{
     var items = data.d.results;
     for(var i = 0; i < items.length;i++) {
         console.log(items[i].Title);
     }    
})
.fail(function(error){
    console.log(JSON.stringify(error));
});
1
votes

You need to use a CAML query to specify a "filter"

In this CAML query you can use the field : FileDirRef and for value the serverRelativeURL of your folder.

This is an exemple of how to execute CAML query using REST API : Using CAML with SharePoint REST API

1
votes

You can access files from specific folders using SharePoint 2013 REST API.

END Point : 

http://<site url>/_api/web/getfolderbyserverrelativeurl('/<folder name>')/files

This URL will return only files located under (one level beneath only) the specified folder.

References :

  1. https://msdn.microsoft.com/en-us/library/office/dn450841.aspx
  2. https://msdn.microsoft.com/en-us/library/office/dn292553.aspx
  3. SharePoint REST API getFolderByServerRelativeUrl Returns Nothing