(DataFlex) List Files and Folders in a SharePoint Documents Library

See more SharePoint Examples

This example shows how to use Chilkat's HttpCurl class to list the files and folders in the root of a SharePoint Documents document library. In Microsoft Graph, a SharePoint document library is represented as a drive. The example demonstrates how HttpCurl automatically resolves the SharePoint site name to a site ID, finds the drive ID for the Documents library, and then retrieves the children of the library's root folder.

Note: This example requires Chilkat v11.0.0 or greater.

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Variant vJsonAuth
    Handle hoJsonAuth
    Handle hoCurl
    String sCurlCommand
    Integer iStatusCode
    Variant vJson
    Handle hoJson
    Integer iNumFiles
    Integer i
    String sTemp1

    Move False To iSuccess

    // This example lists the files and folders in the root of the SharePoint
    // Documents document library.
    // 
    // In Microsoft Graph terminology, a SharePoint document library is represented
    // as a "drive".  The default document library is commonly named "Documents".
    // This example shows how HttpCurl can automatically resolve the needed values:
    // 
    //   site_name  ->  site_id
    //   site_id    ->  document_library_id
    // 
    // After those values are known, the final request lists the children of the
    // root folder in the Documents document library.

    Move False To iSuccess

    // --------------------------------------------------------------------------------------------------------
    // Before running this example, create an Azure App Registration and grant it
    // the Microsoft Graph permissions required to access SharePoint.
    // 
    // The application will authenticate using OAuth2 Client Credentials.
    // See:
    // How to Create SharePoint App Registration for OAuth 2.0 Client Credentials
    // --------------------------------------------------------------------------------------------------------

    // Build a JSON authentication configuration.
    // HttpCurl will use this information to automatically obtain OAuth2 access tokens.
    Get Create (RefClass(cComChilkatJsonObject)) To hoJsonAuth
    If (Not(IsComObjectCreated(hoJsonAuth))) Begin
        Send CreateComObject of hoJsonAuth
    End

    // Enable secret lookup.
    // 
    // Instead of hard-coding sensitive values such as the client ID,
    // client secret, and token endpoint, secret specification strings
    // are used.  Chilkat automatically retrieves the actual values from
    // Windows Credential Manager (Windows) or Apple Keychain (macOS).
    // 
    // See:
    // Secret Specification Strings
    Set ComEnableSecrets Of hoJsonAuth To True

    Get ComUpdateString Of hoJsonAuth "oauth2.client_id" "!!sharepoint|oauth2|client_id" To iSuccess
    If (iSuccess = True) Begin
        Get ComUpdateString Of hoJsonAuth "oauth2.client_secret" "!!sharepoint|oauth2|client_secret" To iSuccess
    End

    If (iSuccess = True) Begin
        Get ComUpdateString Of hoJsonAuth "oauth2.token_endpoint" "!!sharepoint|oauth2|token_endpoint" To iSuccess
    End

    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoJsonAuth To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Request Microsoft Graph permissions that were granted to the application.
    Get ComUpdateString Of hoJsonAuth "oauth2.scope" "https://graph.microsoft.com/.default" To iSuccess

    // ---------------------------------------------------------------------------------------------------

    Get Create (RefClass(cComChilkatHttpCurl)) To hoCurl
    If (Not(IsComObjectCreated(hoCurl))) Begin
        Send CreateComObject of hoCurl
    End

    // Associate the OAuth2 configuration with HttpCurl.
    // 
    // When the request is executed, Chilkat automatically obtains an access token
    // if needed and adds the Authorization: Bearer header to the HTTP request.
    Get pvComObject of hoJsonAuth to vJsonAuth
    Get ComSetAuth Of hoCurl vJsonAuth To iSuccess

    // Define variables whose values are already known.
    // 
    // These variables are referenced in curl commands using
    // {{variable_name}} substitution syntax.
    Send ComSetVar To hoCurl "sharepoint_hostname" "example.sharepoint.com"
    Send ComSetVar To hoCurl "site_name" "test"

    // The final request needs a Microsoft Graph site ID.
    // 
    // Because the application only knows the SharePoint site name,
    // define a helper function that can retrieve the site record.
    // HttpCurl can execute this function automatically when it needs
    // to resolve the site_id variable.
    Get ComAddFunction Of hoCurl "getSite" "GET https://graph.microsoft.com/v1.0/sites/root:/sites/{{site_name}}" To iSuccess

    // Extract the "id" field from the getSite response and store it
    // in the HttpCurl variable named "site_id".
    Get ComAddOutput Of hoCurl "getSite" "id" "site_id" To iSuccess

    // The next value needed is the drive ID for the Documents document library.
    // 
    // This function lists the drives, also known as document libraries,
    // belonging to the SharePoint site.
    Get ComAddFunction Of hoCurl "getDrives" "GET https://graph.microsoft.com/v1.0/sites/{{site_id}}/drives" To iSuccess

    // Extract the ID of the drive whose name is "Documents".
    // 
    // AddOutput2 searches an array in the JSON response.  In this case:
    // 
    //   response array: value
    //   match field:    name
    //   match value:    Documents
    //   case-sensitive: true
    //   output field:   id
    //   variable name:  document_library_id
    // 
    // The result is that document_library_id will contain the drive ID
    // for the Documents document library.
    Get ComAddOutput2 Of hoCurl "getDrives" "value" "name" "Documents" True "id" "document_library_id" To iSuccess

    // The target Microsoft Graph request:
    // 
    // GET https://graph.microsoft.com/v1.0/sites/{{site_id}}/drives/{{document_library_id}}/root/children
    // 
    // This lists the files and folders in the root folder of the Documents
    // document library.
    // 
    // The {{site_id}} and {{document_library_id}} variables are not set directly
    // by this program.  HttpCurl resolves them automatically by running the
    // helper functions defined above.
    Move "GET https://graph.microsoft.com/v1.0/sites/{{site_id}}/drives/{{document_library_id}}/root/children" To sCurlCommand

    // Execute the request.
    // 
    // HttpCurl examines the target request and determines that it requires
    // both site_id and document_library_id.
    // 
    // The execution plan becomes:
    // 
    //   1) Execute getSite to obtain site_id.
    //   2) Execute getDrives to obtain document_library_id.
    //   3) Substitute both variables into the target request.
    //   4) Execute the root/children request.
    // 
    // The final HTTP response returned by DoYourThing is always the response
    // from the target request, which is the last step in the plan.
    Get ComDoYourThing Of hoCurl sCurlCommand To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoCurl To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // A successful Graph response should return HTTP 200.
    // Any other status code typically indicates an authentication,
    // permission, site lookup, or document library lookup error.
    Get ComStatusCode Of hoCurl To iStatusCode
    If (iStatusCode <> 200) Begin
        Get ComResponseBodyStr Of hoCurl To sTemp1
        Showln sTemp1
        Showln "status code = " iStatusCode
        Procedure_Return
    End

    // The response body contains a JSON array named "value".
    // Each element represents one file or folder in the root of the
    // Documents document library.
    Get Create (RefClass(cComChilkatJsonObject)) To hoJson
    If (Not(IsComObjectCreated(hoJson))) Begin
        Send CreateComObject of hoJson
    End
    Set ComEmitCompact Of hoJson To False
    Get pvComObject of hoJson to vJson
    Get ComGetResponseJson Of hoCurl vJson To iSuccess
    Get ComEmit Of hoJson To sTemp1
    Showln sTemp1
    Showln ""

    // Count the number of items returned in the "value" array.
    // 
    // This includes both files and folders.
    Get ComSizeOfArray Of hoJson "value" To iNumFiles
    Showln "Number of files: " iNumFiles
    Showln ""

    // Iterate over the files and folders returned by Microsoft Graph
    // and display selected properties for each item.
    Move 0 To i
    While (i < iNumFiles)
        Set ComI Of hoJson To i

        Get ComStringOf Of hoJson "value[i].name" To sTemp1
        Showln "name: " sTemp1
        Get ComStringOf Of hoJson "value[i].webUrl" To sTemp1
        Showln "webUrl: " sTemp1
        Get ComStringOf Of hoJson "value[i].size" To sTemp1
        Showln "size: " sTemp1
        Get ComStringOf Of hoJson "value[i].id" To sTemp1
        Showln "id: " sTemp1
        Showln "-"
        Move (i + 1) To i
    Loop



End_Procedure