(SQL Server) SharePoint -- Download File (Site Collection)

Demonstrates how to download a file from SharePoint located in the /Documents folder in a site within a site collection.

The format for a URL for a resource contained in a site within a site collection is like this:

https://contoso.com/sites/teamA/_api/web/GetFolderByServerRelativeUrl('/sites/teamA/Documents')/Files('SomeDocument.docx')/$value

Notice that the "/sites/teamA" (where "teamA" is the name of the site) occurs twice in the URL.

For more information, see https://docs.microsoft.com/en-us/sharepoint/sites/sites-and-site-collections-overview

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

-- 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)
    -- This requires the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    -- -------------------------------------------------------------------------
    -- The following comments apply to SharePoint Windows classic authentication.
    -- -------------------------------------------------------------------------
    -- For example, imagine our SharePoint endpoint is https://xyzoffice.mycompany.com/
    -- The SHAREPOINT_NTLM_DOMAIN would be "mycompany.com"
    -- The SHAREPOINT_HTTPS_DOMAIN would be "xyzoffice.mycompany.com"
    -- Also, the SHAREPOINT_USERNAME would be just the name, not a full email address.
    -- for example, "chilkat" instead of "chilkat@mycompany.com"

    DECLARE @http int
    -- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    -- If SharePoint Windows classic authentication is used, then set the 
    -- Login, Password, LoginDomain, and NtlmAuth properties.
    EXEC sp_OASetProperty @http, 'Login', 'SHAREPOINT_USERNAME'
    EXEC sp_OASetProperty @http, 'Password', 'SHAREPOINT_PASSWORD'
    EXEC sp_OASetProperty @http, 'LoginDomain', 'SHAREPOINT_NTLM_DOMAIN'
    EXEC sp_OASetProperty @http, 'NtlmAuth', 1

    -- -------------------------------------------------------------------------
    -- The more common case is to use SharePoint Online authentication (via the SPOIDCRL cookie).
    -- If so, do not set Login, Password, LoginDomain, and NtlmAuth, and instead
    -- establish the cookie as shown at SharePoint Online Authentication
    -- -------------------------------------------------------------------------

    -- This example downloads the file named "Domain Name created for Exchange.docx"

    -- Note: I was initially confused by the "$value" part of the URL. 
    -- When I see something like $value, I immediately think that it's some sort of
    -- variable or placeholder to be replaced with an actual value.  In this case,
    -- the "$value" is literally part of the URL.  It's not replace with anything.

    -- --------------------------------------------------------------------------------
    -- IMPORTANT: The format for a URL within a site collection is like this:
    -- https://SHAREPOINT_HTTPS_DOMAIN/sites/teamA/_api/web/GetFolderByServerRelativeUrl('/sites/teamA/Documents')/Files('Domain Name created for Exchange.docx')/$value
    -- 
    -- Notice that "/sites/teamA" is specified twice in the above sample URL.
    -- --------------------------------------------------------------------------------

    DECLARE @url nvarchar(4000)
    SELECT @url = 'https://SHAREPOINT_HTTPS_DOMAIN/sites/teamA/_api/web/GetFolderByServerRelativeUrl(''/sites/teamA/Documents'')/Files(''Domain Name created for Exchange.docx'')/$value'
    DECLARE @localFilePath nvarchar(4000)
    SELECT @localFilePath = 'qa_output/x.docx'

    DECLARE @success int
    EXEC sp_OAMethod @http, 'Download', @success OUT, @url, @localFilePath
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        RETURN
      END


    PRINT 'File successfully downloaded from a SharePoint site within a site collection.'

    EXEC @hr = sp_OADestroy @http


END
GO