|
Chilkat • HOME • Android™ • AutoIt • C • C# • C++ • Chilkat2-Python • CkPython • Classic ASP • DataFlex • Delphi DLL • Go • Java • JavaScript • Node.js • Objective-C • PHP Extension • Perl • PowerBuilder • PowerShell • PureBasic • Ruby • SQL Server • Swift • Tcl • Unicode C • Unicode C++ • VB.NET • VBScript • Visual Basic 6.0 • Visual FoxPro • Xojo Plugin
(SQL Server) Download a File from a SharePoint Documents LibrarySee more SharePoint Examples
This example shows how to use Chilkat's
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls. -- CREATE PROCEDURE ChilkatSample AS BEGIN DECLARE @hr int -- Important: Do not use nvarchar(max). See the warning about using nvarchar(max). DECLARE @sTmp0 nvarchar(4000) DECLARE @success int SELECT @success = 0 -- This example downloads a file named "hamlet.json" from the root of the SharePoint -- Documents document library. -- -- The example demonstrates how HttpCurl can automatically resolve all of the -- information needed to locate and download a file: -- -- site_name -> site_id -- site_id -> document_library_id -- document_library_id -> file_id -- file_id -> file content -- -- The application only provides the SharePoint site name and the desired -- filename. HttpCurl automatically executes the required Microsoft Graph -- requests to obtain the remaining values. 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 first step is to obtain the Microsoft Graph site ID. -- -- The application only knows the SharePoint site name, so define -- a 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 next step is to find 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' -- Now list the contents of the Documents document library. EXEC sp_OAMethod @curl, 'AddFunction', @success OUT, 'getFiles', 'GET https://graph.microsoft.com/v1.0/sites/{{site_id}}/drives/{{document_library_id}}/root/children' -- Search the returned files for an item named "hamlet.json" -- and save its Microsoft Graph item ID in the file_id variable. EXEC sp_OAMethod @curl, 'AddOutput2', @success OUT, 'getFiles', 'value', 'name', 'hamlet.json', 1, 'id', 'file_id' -- This is the target request. -- -- GET -L https://graph.microsoft.com/v1.0/drives/{{document_library_id}}/items/{{file_id}}/content -- -- The /content endpoint returns the actual contents of the file. -- -- The -L option instructs HttpCurl to follow the redirect returned by -- Microsoft Graph. The Graph API typically responds with a redirect -- to the actual file download URL. DECLARE @curlCommand nvarchar(4000) SELECT @curlCommand = 'GET -L https://graph.microsoft.com/v1.0/drives/{{document_library_id}}/items/{{file_id}}/content' -- Execute the request. -- -- HttpCurl examines the target request and determines that both -- document_library_id and file_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) getFiles -> file_id -- 4) download -> file content -- -- The final response returned by DoYourThing is the downloaded -- file content from the target request. 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 response body contains the contents of the downloaded file. DECLARE @sbFileContents int EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbFileContents OUT EXEC sp_OAMethod @curl, 'GetResponseSb', @success OUT, @sbFileContents -- Optionally save the downloaded content to a local file. -- -- The third argument controls whether the file is appended. -- Passing ckfalse causes the file to be overwritten if it already exists. EXEC sp_OAMethod @sbFileContents, 'WriteFile', @success OUT, 'c:/temp/hamlet.json', 'utf-8', 0 IF @success = 0 BEGIN EXEC sp_OAGetProperty @sbFileContents, 'LastErrorText', @sTmp0 OUT PRINT @sTmp0 EXEC @hr = sp_OADestroy @jsonAuth EXEC @hr = sp_OADestroy @curl EXEC @hr = sp_OADestroy @sbFileContents RETURN END PRINT 'Success.' EXEC @hr = sp_OADestroy @jsonAuth EXEC @hr = sp_OADestroy @curl EXEC @hr = sp_OADestroy @sbFileContents END GO |
||||
© 2000-2026 Chilkat Software, Inc. All Rights Reserved.