Can't list folders using SharePoint REST API

Question

Based on Microsoft Sharepoint Documentation Here I am trying to list my Sharepoint application document libraries & folders using the REST API.

I have tried by Java using apache HTTP client and using Postman in both ways failing with status code 400 and error message: Value does not fall within the expected range.

Below is the response error messages:

<?xml version="1.0" encoding="utf-8"?>
<m:error xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata">
    <m:code>-2147024809, System.ArgumentException</m:code>
    <m:message xml:lang="en-US">Value does not fall within the expected range.</m:message>
</m:error>

Here is a screenshot of the postman:

I am using NTLM Authentication

Here is my java code sample (test case):

@Test
public void testListFolders() {
    // SharePoint site URL and API endpoint
    String siteUrl = "http://sharepoint2013.MY_SITE_NAME.com/sites/home";
    String apiEndpoint = "/_api/web/GetFolderByServerRelativeUrl('/Shared%20Documents')/Folders";

    CredentialsProvider credsProvider = new BasicCredentialsProvider();
    credsProvider.setCredentials(new AuthScope(AuthScope.ANY),
            new NTCredentials(String.join(":", "MY_USERNAME", "MY_PASSWORD")));

    RequestConfig defaultRequestConfig = RequestConfig.custom()
            .setExpectContinueEnabled(false)
            .setTargetPreferredAuthSchemes(Arrays.asList(AuthSchemes.NTLM, AuthSchemes.DIGEST))
            .setProxyPreferredAuthSchemes(Collections.singletonList(AuthSchemes.BASIC))
            .build();

    // Create HttpClient instance
    CloseableHttpClient httpClient = HttpClients.custom()
                                                .setDefaultCredentialsProvider(credsProvider)
                                                .setDefaultRequestConfig(defaultRequestConfig)
                                                .build();
    // Create HTTP GET request
    HttpGet request = new HttpGet(siteUrl + apiEndpoint);
    request.setHeader(HttpHeaders.ACCEPT, "application/json;odata=verbose");

    try {
        // Execute the request
        HttpResponse response = httpClient.execute(request);
        System.out.println("Status code: " + response.getStatusLine().getStatusCode());
    } catch (Exception e) {
        e.printStackTrace();
    } finally {
        try {
            httpClient.close();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

The status code is always 400 and same error message as form Postman.

If I replace the endpoint for this test case to be the endpoint to list Sharepoint list: /_api/web/Lists/?$Select=Title%2CIsApplicationList%2CContentTypesEnabled%2CHidden%2CBaseType%2CItemCount%2CIsCatalog&$Filter=BaseType%20eq%200%20and%20Hidden%20eq%20false it will work fine and return a valid response and status code 200

Is there a specific header I am missing to list folders from Sharepoint using the REST API?
Or is there some permissions or configurations I need to set/enable from Sharepoint application?
Or is there something wrong in the code / request I am doing?

Muhammad Murad Haider · Accepted Answer · 2023-08-23 14:55:55Z

0

you may need separate API calls for this. you can get lists/document libraries using '_api/web/lists' endpoint. Then for each list you can hit 'list/getbytitle('listname')/items' endpoint to get list's items. Here the catch is, you can use filter parameter to get only the folders i.e. '$filter= 'FileSystemObjectType = 1'. This should return you only the folders in the response.

answered Aug 23, 2023 at 14:55

Muhammad Murad Haider

1,5272 gold badges19 silver badges39 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Can't list folders using SharePoint REST API

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related