SQL Server
SQL Server
Download a SharePoint File by Path using HttpCurl
See more SharePoint Examples
This example shows how to use Chilkat's HttpCurl class to download a file from SharePoint when the file path within the document library is already known. The example uses Microsoft Graph to automatically resolve the SharePoint site name to a site ID, find the drive ID for the Documents document library, and then download the file directly by path using the Graph root:/path:/content syntax.
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 downloads a file from a SharePoint Documents document library
-- when the file's path within the library is already known.
--
-- The file downloaded in this example is:
--
-- images/sea_creatures/starfish.jpg
--
-- Unlike the previous example that searched for a file by name and obtained
-- its Microsoft Graph item ID, this example uses the Graph path-based API.
--
-- The example demonstrates how HttpCurl automatically resolves:
--
-- site_name -> site_id
-- site_id -> document_library_id
--
-- and then uses the known file path to download the file directly.
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 values that 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 download request requires a Microsoft Graph site ID.
--
-- Because the application only knows the SharePoint site name,
-- define a helper function that can retrieve the site information.
EXEC sp_OAMethod @curl, 'AddFunction', @success OUT, 'getSite', 'GET https://graph.microsoft.com/v1.0/sites/root:/sites/{{site_name}}'
-- Extract the site's ID and store it in the HttpCurl variable named site_id.
EXEC sp_OAMethod @curl, 'AddOutput', @success OUT, 'getSite', 'id', 'site_id'
-- The download request also requires the drive ID of the Documents
-- document library.
--
-- Microsoft Graph refers to document libraries as "drives".
EXEC sp_OAMethod @curl, 'AddFunction', @success OUT, 'getDrives', 'GET https://graph.microsoft.com/v1.0/sites/{{site_id}}/drives'
-- Search the returned drives for the one named "Documents"
-- and save its drive ID in the document_library_id variable.
EXEC sp_OAMethod @curl, 'AddOutput2', @success OUT, 'getDrives', 'value', 'name', 'Documents', 1, 'id', 'document_library_id'
-- This is the target Microsoft Graph request.
--
-- GET /sites/{site-id}/drives/{drive-id}/root:/{path-to-file}:/content
--
-- The path-based API allows a file to be downloaded directly when its
-- location within the document library is known.
--
-- The -L option causes HttpCurl to follow redirects.
-- Microsoft Graph typically returns a redirect to the actual download URL.
--
-- The -o option specifies the output filename.
-- The --output-dir option specifies the directory where the downloaded
-- file will be saved.
DECLARE @curlCommand nvarchar(4000)
SELECT @curlCommand = 'GET -L --output-dir c:/temp/qa_output -o starfish.jpg https://graph.microsoft.com/v1.0/sites/{{site_id}}/drives/{{document_library_id}}/root:/images/sea_creatures/starfish.jpg:/content'
-- Execute the request.
--
-- HttpCurl examines the target request and determines that both
-- site_id and document_library_id are required.
--
-- To obtain these values, it automatically builds and executes
-- the following dependency chain:
--
-- 1) getSite -> site_id
-- 2) getDrives -> document_library_id
-- 3) download -> file content
--
-- The file is streamed directly to the output file specified by
-- the curl command.
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, document library lookup, or file 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 file has been downloaded successfully and written to:
--
-- c:/temp/qa_output/starfish.jpg
--
PRINT 'Success.'
EXEC @hr = sp_OADestroy @jsonAuth
EXEC @hr = sp_OADestroy @curl
END
GO