SQL Server Requires Chilkat v11.0.0+
SQL Server
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.
Chilkat SQL Server Downloads
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @sTmp0 nvarchar(4000)
DECLARE @success int
SELECT @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.
SELECT @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.
DECLARE @jsonAuth int
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jsonAuth OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
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
EXEC sp_OASetProperty @jsonAuth, 'EnableSecrets', 1
EXEC sp_OAMethod @jsonAuth, 'UpdateString', @success OUT, 'oauth2.client_id', '!!sharepoint|oauth2|client_id'
IF @success = 1
BEGIN
EXEC sp_OAMethod @jsonAuth, 'UpdateString', @success OUT, 'oauth2.client_secret', '!!sharepoint|oauth2|client_secret'
END
IF @success = 1
BEGIN
EXEC sp_OAMethod @jsonAuth, 'UpdateString', @success OUT, 'oauth2.token_endpoint', '!!sharepoint|oauth2|token_endpoint'
END
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @jsonAuth, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @jsonAuth
RETURN
END
-- Request Microsoft Graph permissions that were granted to the application.
EXEC sp_OAMethod @jsonAuth, 'UpdateString', @success OUT, 'oauth2.scope', 'https://graph.microsoft.com/.default'
-- ---------------------------------------------------------------------------------------------------
DECLARE @curl int
EXEC @hr = sp_OACreate 'Chilkat.HttpCurl', @curl OUT
-- 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.
EXEC sp_OAMethod @curl, 'SetAuth', @success OUT, @jsonAuth
-- Define variables whose values are already known.
--
-- These variables are referenced in curl commands using
-- {{variable_name}} substitution syntax.
EXEC sp_OAMethod @curl, 'SetVar', NULL, 'sharepoint_hostname', 'example.sharepoint.com'
EXEC sp_OAMethod @curl, 'SetVar', NULL, '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.
EXEC sp_OAMethod @curl, 'AddFunction', @success OUT, '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".
EXEC sp_OAMethod @curl, 'AddOutput', @success OUT, '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.
EXEC sp_OAMethod @curl, 'AddFunction', @success OUT, '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.
EXEC sp_OAMethod @curl, 'AddOutput2', @success OUT, '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.
DECLARE @curlCommand nvarchar(4000)
SELECT @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.
EXEC sp_OAMethod @curl, 'DoYourThing', @success OUT, @curlCommand
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @curl, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @jsonAuth
EXEC @hr = sp_OADestroy @curl
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.
DECLARE @statusCode int
EXEC sp_OAGetProperty @curl, 'StatusCode', @statusCode OUT
IF @statusCode <> 200
BEGIN
EXEC sp_OAGetProperty @curl, 'ResponseBodyStr', @sTmp0 OUT
PRINT @sTmp0
PRINT 'status code = ' + @statusCode
EXEC @hr = sp_OADestroy @jsonAuth
EXEC @hr = sp_OADestroy @curl
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.
DECLARE @json int
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT
EXEC sp_OASetProperty @json, 'EmitCompact', 0
EXEC sp_OAMethod @curl, 'GetResponseJson', @success OUT, @json
EXEC sp_OAMethod @json, 'Emit', @sTmp0 OUT
PRINT @sTmp0
PRINT ''
-- Count the number of items returned in the "value" array.
--
-- This includes both files and folders.
DECLARE @numFiles int
EXEC sp_OAMethod @json, 'SizeOfArray', @numFiles OUT, 'value'
PRINT 'Number of files: ' + @numFiles
PRINT ''
-- Iterate over the files and folders returned by Microsoft Graph
-- and display selected properties for each item.
DECLARE @i int
SELECT @i = 0
WHILE @i < @numFiles
BEGIN
EXEC sp_OASetProperty @json, 'I', @i
EXEC sp_OAMethod @json, 'StringOf', @sTmp0 OUT, 'value[i].name'
PRINT 'name: ' + @sTmp0
EXEC sp_OAMethod @json, 'StringOf', @sTmp0 OUT, 'value[i].webUrl'
PRINT 'webUrl: ' + @sTmp0
EXEC sp_OAMethod @json, 'StringOf', @sTmp0 OUT, 'value[i].size'
PRINT 'size: ' + @sTmp0
EXEC sp_OAMethod @json, 'StringOf', @sTmp0 OUT, 'value[i].id'
PRINT 'id: ' + @sTmp0
PRINT '-'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @jsonAuth
EXEC @hr = sp_OADestroy @curl
EXEC @hr = sp_OADestroy @json
END
GO