PureBasic

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.

PureBasic

IncludeFile "CkHttpCurl.pb"
IncludeFile "CkJsonObject.pb"

Procedure ChilkatExample()

    success.i = 0

    ; 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.

    success = 0

    ; --------------------------------------------------------------------------------------------------------
    ; 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.
    jsonAuth.i = CkJsonObject::ckCreate()
    If jsonAuth.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; 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
    CkJsonObject::setCkEnableSecrets(jsonAuth, 1)

    success = CkJsonObject::ckUpdateString(jsonAuth,"oauth2.client_id","!!sharepoint|oauth2|client_id")
    If success = 1
        success = CkJsonObject::ckUpdateString(jsonAuth,"oauth2.client_secret","!!sharepoint|oauth2|client_secret")
    EndIf

    If success = 1
        success = CkJsonObject::ckUpdateString(jsonAuth,"oauth2.token_endpoint","!!sharepoint|oauth2|token_endpoint")
    EndIf

    If success = 0
        Debug CkJsonObject::ckLastErrorText(jsonAuth)
        CkJsonObject::ckDispose(jsonAuth)
        ProcedureReturn
    EndIf

    ; Request Microsoft Graph permissions that were granted to the application.
    CkJsonObject::ckUpdateString(jsonAuth,"oauth2.scope","https://graph.microsoft.com/.default")

    ; ---------------------------------------------------------------------------------------------------

    curl.i = CkHttpCurl::ckCreate()
    If curl.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; 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.
    CkHttpCurl::ckSetAuth(curl,jsonAuth)

    ; Define variables whose values are already known.
    ; 
    ; These variables are referenced in the curl command using
    ; {{variable_name}} substitution syntax.
    CkHttpCurl::ckSetVar(curl,"sharepoint_hostname","example.sharepoint.com")
    CkHttpCurl::ckSetVar(curl,"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.
    CkHttpCurl::ckAddFunction(curl,"getSite","GET https://graph.microsoft.com/v1.0/sites/root:/sites/{{site_name}}")

    ; 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.
    CkHttpCurl::ckAddOutput(curl,"getSite","id","site_id")

    ; 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.
    curlCommand.s = "curl -X GET " + Chr(34) + "https://graph.microsoft.com/v1.0/sites/{{site_id}}/drives" + Chr(34)

    ; 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.
    success = CkHttpCurl::ckDoYourThing(curl,curlCommand)
    If success = 0
        Debug CkHttpCurl::ckLastErrorText(curl)
        CkJsonObject::ckDispose(jsonAuth)
        CkHttpCurl::ckDispose(curl)
        ProcedureReturn
    EndIf

    ; A successful Graph response should return HTTP 200.
    ; Any other status code typically indicates an authentication,
    ; permission, or resource lookup error.
    statusCode.i = CkHttpCurl::ckStatusCode(curl)
    If statusCode <> 200
        Debug CkHttpCurl::ckResponseBodyStr(curl)
        Debug "status code = " + Str(statusCode)
        CkJsonObject::ckDispose(jsonAuth)
        CkHttpCurl::ckDispose(curl)
        ProcedureReturn
    EndIf

    ; The response body contains a JSON array named "value".
    ; Each element of the array describes a SharePoint document library.
    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::setCkEmitCompact(json, 0)
    CkHttpCurl::ckGetResponseJson(curl,json)
    Debug CkJsonObject::ckEmit(json)

    ; Iterate over the document libraries returned by Microsoft Graph
    ; and display selected properties for each library.
    i.i = 0
    numDrives.i = CkJsonObject::ckSizeOfArray(json,"value")
    While i < numDrives
        CkJsonObject::setCkI(json, i)
        Debug "name: " + CkJsonObject::ckStringOf(json,"value[i].name")
        Debug "description: " + CkJsonObject::ckStringOf(json,"value[i].description")
        Debug "id: " + CkJsonObject::ckStringOf(json,"value[i].id")
        Debug "webUrl: " + CkJsonObject::ckStringOf(json,"value[i].webUrl")
        Debug "displayName: " + CkJsonObject::ckStringOf(json,"value[i].createdBy.user.displayName")
        Debug "-"
        i = i + 1
    Wend

    Debug "Success."


    CkJsonObject::ckDispose(jsonAuth)
    CkHttpCurl::ckDispose(curl)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure