Pascal (Lazarus/Delphi)

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.

Pascal (Lazarus/Delphi)

program ChilkatDemo;

// Demonstrates using the Chilkat Pascal wrapper via the C bridge DLL.
// Builds as a console application under Lazarus (FPC) or Delphi.

{$IFDEF FPC}
  {$MODE DELPHI}
{$ENDIF}
{$APPTYPE CONSOLE}

uses
  {$IFDEF UNIX}
  cthreads,
  {$ENDIF}
  SysUtils,
  CkDllLoader,
  Chilkat.JsonObject,
  Chilkat.HttpCurl;

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

procedure RunDemo;
var
  success: Boolean;
  jsonAuth: TJsonObject;
  curl: THttpCurl;
  curlCommand: string;
  statusCode: Integer;
  json: TJsonObject;
  i: Integer;
  numDrives: Integer;

begin
  success := False;

  //  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 := False;

  //  --------------------------------------------------------------------------------------------------------
  //  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 := TJsonObject.Create;

  //  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
  jsonAuth.EnableSecrets := True;

  success := jsonAuth.UpdateString('oauth2.client_id','!!sharepoint|oauth2|client_id');
  if (success = True) then
    begin
      success := jsonAuth.UpdateString('oauth2.client_secret','!!sharepoint|oauth2|client_secret');
    end;
  if (success = True) then
    begin
      success := jsonAuth.UpdateString('oauth2.token_endpoint','!!sharepoint|oauth2|token_endpoint');
    end;
  if (success = False) then
    begin
      WriteLn(jsonAuth.LastErrorText);
      Exit;
    end;

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

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

  curl := THttpCurl.Create;

  //  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.
  curl.SetAuth(jsonAuth);

  //  Define variables whose values are already known.
  //  
  //  These variables are referenced in the curl command using
  //  {{variable_name}} substitution syntax.
  curl.SetVar('sharepoint_hostname','example.sharepoint.com');
  curl.SetVar('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.
  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".
  //  
  //  Any later request that references {{site_id}} can use this value.
  curl.AddOutput('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 := 'curl -X GET "https://graph.microsoft.com/v1.0/sites/{{site_id}}/drives"';

  //  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 := curl.DoYourThing(curlCommand);
  if (success = False) then
    begin
      WriteLn(curl.LastErrorText);
      Exit;
    end;

  //  A successful Graph response should return HTTP 200.
  //  Any other status code typically indicates an authentication,
  //  permission, or resource lookup error.
  statusCode := curl.StatusCode;
  if (statusCode <> 200) then
    begin
      WriteLn(curl.ResponseBodyStr);
      WriteLn('status code = ' + statusCode);
      Exit;
    end;

  //  The response body contains a JSON array named "value".
  //  Each element of the array describes a SharePoint document library.
  json := TJsonObject.Create;
  json.EmitCompact := False;
  curl.GetResponseJson(json);
  WriteLn(json.Emit());

  //  Iterate over the document libraries returned by Microsoft Graph
  //  and display selected properties for each library.
  i := 0;
  numDrives := json.SizeOfArray('value');
  while i < numDrives do
    begin
      json.I := i;
      WriteLn('name: ' + json.StringOf('value[i].name'));
      WriteLn('description: ' + json.StringOf('value[i].description'));
      WriteLn('id: ' + json.StringOf('value[i].id'));
      WriteLn('webUrl: ' + json.StringOf('value[i].webUrl'));
      WriteLn('displayName: ' + json.StringOf('value[i].createdBy.user.displayName'));
      WriteLn('-');
      i := i + 1;
    end;

  WriteLn('Success.');


  jsonAuth.Free;
  curl.Free;
  json.Free;

end;

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

begin

  try
    RunDemo;
  except
    on E: Exception do
      WriteLn('Unhandled exception: ', E.ClassName, ': ', E.Message);
  end;

  WriteLn;
  {$IFDEF MSWINDOWS}
  WriteLn('Press Enter to exit...');
  ReadLn;
  {$ENDIF}
end.