SQL Server Requires Chilkat v11.5.0+
SQL Server
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.
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 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.
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 the curl command 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 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.
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".
--
-- Any later request that references {{site_id}} can use this value.
EXEC sp_OAMethod @curl, 'AddOutput', @success OUT, '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.
DECLARE @curlCommand nvarchar(4000)
SELECT @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.
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, or resource 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 of the array describes a SharePoint 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
-- Iterate over the document libraries returned by Microsoft Graph
-- and display selected properties for each library.
DECLARE @i int
SELECT @i = 0
DECLARE @numDrives int
EXEC sp_OAMethod @json, 'SizeOfArray', @numDrives OUT, 'value'
WHILE @i < @numDrives
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].description'
PRINT 'description: ' + @sTmp0
EXEC sp_OAMethod @json, 'StringOf', @sTmp0 OUT, 'value[i].id'
PRINT 'id: ' + @sTmp0
EXEC sp_OAMethod @json, 'StringOf', @sTmp0 OUT, 'value[i].webUrl'
PRINT 'webUrl: ' + @sTmp0
EXEC sp_OAMethod @json, 'StringOf', @sTmp0 OUT, 'value[i].createdBy.user.displayName'
PRINT 'displayName: ' + @sTmp0
PRINT '-'
SELECT @i = @i + 1
END
PRINT 'Success.'
EXEC @hr = sp_OADestroy @jsonAuth
EXEC @hr = sp_OADestroy @curl
EXEC @hr = sp_OADestroy @json
END
GO