DataFlex

SharePoint List Document Libraries

See more SharePoint Examples

This example shows how to use Chilkat's HttpCurl class to list the document libraries in a SharePoint site. In Microsoft Graph, SharePoint document libraries are represented as drives. The example demonstrates how HttpCurl can automatically resolve a SharePoint site name to its Microsoft Graph site ID, then use that ID to retrieve and display the site's document libraries.

DataFlex

Use ChilkatAx-win32.pkg

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

    Move False To iSuccess

    // This example retrieves the document libraries for a SharePoint site.
    // 
    // In Microsoft Graph terminology, a document library is represented as a "drive".
    // The example demonstrates how HttpCurl can automatically resolve a SharePoint
    // site name to a site ID before requesting the site's document libraries.

    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 the curl command using
    // {{variable_name}} substitution syntax.
    Send ComSetVar To hoCurl "sharepoint_hostname" "example.sharepoint.com"
    Send ComSetVar To hoCurl "site_name" "test"

    // The document libraries endpoint requires a Microsoft Graph site ID.
    // 
    // Because the application only knows the SharePoint site name,
    // HttpCurl must first retrieve the corresponding site ID.
    // 
    // Define a function that can resolve the site_id variable when needed.
    // HttpCurl may execute this function automatically if it determines that
    // site_id is required by another request.
    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".
    // 
    // Any later request that references {{site_id}} can use this value.
    Get ComAddOutput Of hoCurl "getSite" "id" "site_id" To iSuccess

    // The target Microsoft Graph request:
    // 
    // curl -X GET \"https://graph.microsoft.com/v1.0/sites/{{site_id}}/drives
    // 
    // This request returns the document libraries belonging to the site.
    // 
    // Microsoft Graph refers to document libraries as "drives",
    // so each object in the response represents one document library.
    // 
    // No Authorization header is included because HttpCurl automatically
    // adds it when OAuth2 authentication is configured.
    Move 'curl -X GET "https://graph.microsoft.com/v1.0/sites/{{site_id}}/drives"' To sCurlCommand

    // Execute the request.
    // 
    // HttpCurl examines the target curl command and determines that
    // the variable {{site_id}} is required.
    // 
    // Because site_id is not yet known, HttpCurl searches for a function
    // capable of producing it.  The getSite function provides the "id"
    // output, which is mapped to the site_id variable.
    // 
    // The execution plan becomes:
    // 
    //   1) Execute getSite to obtain site_id.
    //   2) Substitute {{site_id}} into the target request.
    //   3) Execute the drives request.
    // 
    // The final HTTP response returned by DoYourThing is always the
    // response from the target curl command, 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, or resource 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 of the array describes a SharePoint 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

    // Iterate over the document libraries returned by Microsoft Graph
    // and display selected properties for each library.
    Move 0 To i
    Get ComSizeOfArray Of hoJson "value" To iNumDrives
    While (i < iNumDrives)
        Set ComI Of hoJson To i
        Get ComStringOf Of hoJson "value[i].name" To sTemp1
        Showln "name: " sTemp1
        Get ComStringOf Of hoJson "value[i].description" To sTemp1
        Showln "description: " sTemp1
        Get ComStringOf Of hoJson "value[i].id" To sTemp1
        Showln "id: " sTemp1
        Get ComStringOf Of hoJson "value[i].webUrl" To sTemp1
        Showln "webUrl: " sTemp1
        Get ComStringOf Of hoJson "value[i].createdBy.user.displayName" To sTemp1
        Showln "displayName: " sTemp1
        Showln "-"
        Move (i + 1) To i
    Loop

    Showln "Success."


End_Procedure