PowerBuilder Requires Chilkat v11.0.0+

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.

PowerBuilder

integer li_rc
integer li_Success
oleobject loo_JsonAuth
oleobject loo_Curl
string ls_CurlCommand
integer li_StatusCode
oleobject loo_Json
integer li_NumFiles
integer i

li_Success = 0

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

li_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.
loo_JsonAuth = create oleobject
li_rc = loo_JsonAuth.ConnectToNewObject("Chilkat.JsonObject")
if li_rc < 0 then
    destroy loo_JsonAuth
    MessageBox("Error","Connecting to COM object failed")
    return
end if

//  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
loo_JsonAuth.EnableSecrets = 1

li_Success = loo_JsonAuth.UpdateString("oauth2.client_id","!!sharepoint|oauth2|client_id")
if li_Success = 1 then
    li_Success = loo_JsonAuth.UpdateString("oauth2.client_secret","!!sharepoint|oauth2|client_secret")
end if

if li_Success = 1 then
    li_Success = loo_JsonAuth.UpdateString("oauth2.token_endpoint","!!sharepoint|oauth2|token_endpoint")
end if

if li_Success = 0 then
    Write-Debug loo_JsonAuth.LastErrorText
    destroy loo_JsonAuth
    return
end if

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

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

loo_Curl = create oleobject
li_rc = loo_Curl.ConnectToNewObject("Chilkat.HttpCurl")

//  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.
loo_Curl.SetAuth(loo_JsonAuth)

//  Define variables whose values are already known.
//  
//  These variables are referenced in curl commands using
//  {{variable_name}} substitution syntax.
loo_Curl.SetVar("sharepoint_hostname","example.sharepoint.com")
loo_Curl.SetVar("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.
loo_Curl.AddFunction("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".
loo_Curl.AddOutput("getSite","id","site_id")

//  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.
loo_Curl.AddFunction("getDrives","GET https://graph.microsoft.com/v1.0/sites/{{site_id}}/drives")

//  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.
loo_Curl.AddOutput2("getDrives","value","name","Documents",1,"id","document_library_id")

//  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.
ls_CurlCommand = "GET https://graph.microsoft.com/v1.0/sites/{{site_id}}/drives/{{document_library_id}}/root/children"

//  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.
li_Success = loo_Curl.DoYourThing(ls_CurlCommand)
if li_Success = 0 then
    Write-Debug loo_Curl.LastErrorText
    destroy loo_JsonAuth
    destroy loo_Curl
    return
end if

//  A successful Graph response should return HTTP 200.
//  Any other status code typically indicates an authentication,
//  permission, site lookup, or document library lookup error.
li_StatusCode = loo_Curl.StatusCode
if li_StatusCode <> 200 then
    Write-Debug loo_Curl.ResponseBodyStr
    Write-Debug "status code = " + string(li_StatusCode)
    destroy loo_JsonAuth
    destroy loo_Curl
    return
end if

//  The response body contains a JSON array named "value".
//  Each element represents one file or folder in the root of the
//  Documents document library.
loo_Json = create oleobject
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")

loo_Json.EmitCompact = 0
loo_Curl.GetResponseJson(loo_Json)
Write-Debug loo_Json.Emit()
Write-Debug ""

//  Count the number of items returned in the "value" array.
//  
//  This includes both files and folders.
li_NumFiles = loo_Json.SizeOfArray("value")
Write-Debug "Number of files: " + string(li_NumFiles)
Write-Debug ""

//  Iterate over the files and folders returned by Microsoft Graph
//  and display selected properties for each item.
i = 0
do while i < li_NumFiles
    loo_Json.I = i

    Write-Debug "name: " + loo_Json.StringOf("value[i].name")
    Write-Debug "webUrl: " + loo_Json.StringOf("value[i].webUrl")
    Write-Debug "size: " + loo_Json.StringOf("value[i].size")
    Write-Debug "id: " + loo_Json.StringOf("value[i].id")
    Write-Debug "-"
    i = i + 1
loop


destroy loo_JsonAuth
destroy loo_Curl
destroy loo_Json