(SQL Server) SharePoint -- Get Folder Properties

See more SharePoint Examples

This example shows how to get the properties of a SharePoint folder. Specifically, it gets the properties of one of our test folders named "Briefing 02032017".

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
    -- -------------------------------------------------------------------------

    -- Indicate that we want a JSON reply
    EXEC sp_OASetProperty @http, 'Accept', 'application/json;odata=verbose'
    EXEC sp_OASetProperty @http, 'AcceptCharset', 'utf-8'

    -- If your Sharepoint site is within a site collection, then use "https://SHAREPOINT_HTTPS_DOMAIN/sites/teamA/_api/web/GetFolderByServerRelativeUrl('/sites/teamA/Briefing 02032017')" where "teamA" is the name of the site.
    DECLARE @sbJson int
    -- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbJson OUT

    DECLARE @success int
    EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://SHAREPOINT_HTTPS_DOMAIN/_api/web/GetFolderByServerRelativeUrl(''/Briefing 02032017'')', @sbJson
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @sbJson
        RETURN
      END

    DECLARE @json int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT

    EXEC sp_OAMethod @json, 'LoadSb', @success OUT, @sbJson
    EXEC sp_OASetProperty @json, 'EmitCompact', 0

    -- To get the number of items in the folder:
    DECLARE @itemCount int
    EXEC sp_OAMethod @json, 'IntOf', @itemCount OUT, 'd.ItemCount'

    PRINT 'Number of items: ' + @itemCount

    -- The full JSON response looks like the following:
    EXEC sp_OAMethod @json, 'Emit', @sTmp0 OUT
    PRINT @sTmp0

    -- { 
    --   "d": { 
    --     "__metadata": { 
    --       "id": "Web/GetFolderByServerRelativeUrl('/Briefing 02032017')",
    --       "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFolderByServerRelativeUrl('/Briefing%2002032017')",
    --       "type": "SP.Folder"
    --     },
    --     "Files": { 
    --       "__deferred": { 
    --         "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFolderByServerRelativeUrl('/Briefing%2002032017')/Files"
    --       }
    --     },
    --     "ListItemAllFields": { 
    --       "__deferred": { 
    --         "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFolderByServerRelativeUrl('/Briefing%2002032017')/ListItemAllFields"
    --       }
    --     },
    --     "ParentFolder": { 
    --       "__deferred": { 
    --         "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFolderByServerRelativeUrl('/Briefing%2002032017')/ParentFolder"
    --       }
    --     },
    --     "Properties": { 
    --       "__deferred": { 
    --         "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFolderByServerRelativeUrl('/Briefing%2002032017')/Properties"
    --       }
    --     },
    --     "Folders": { 
    --       "__deferred": { 
    --         "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFolderByServerRelativeUrl('/Briefing%2002032017')/Folders"
    --       }
    --     },
    --     "ItemCount": 9,
    --     "Name": "Briefing 02032017",
    --     "ServerRelativeUrl": "/Briefing 02032017",
    --     "WelcomePage": ""
    --   }
    -- }
    -- 

    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @sbJson
    EXEC @hr = sp_OADestroy @json


END
GO