SQL Server
SQL Server
Retrieve a Particular SharePoint List as JSON
See more SharePoint Examples
Downloads a particular SharePoint list and parses the JSON.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 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
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'
-- The contents of a SharePoint list can be downloaded by it's URI,
-- which has the following URL format:
-- https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/items
--
-- To get the URI's for all SharePoint lists,
-- See Get SharePoint Lists.
-- Download the list like this (where the SHAREPOINT_DOCUMENTS_GUID is replaced with the actual GUID)
DECLARE @sbJson int
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbJson OUT
EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/Lists(guid''SHAREPOINT_DOCUMENTS_GUID'')/items', @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
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'LoadSb', @success OUT, @sbJson
EXEC sp_OASetProperty @json, 'EmitCompact', 0
-- Iterate over the items in this list.
DECLARE @numItems int
EXEC sp_OAMethod @json, 'SizeOfArray', @numItems OUT, 'd.results'
PRINT 'Number of Items in this SharePoint List = ' + @numItems
DECLARE @i int
SELECT @i = 0
WHILE @i < @numItems
BEGIN
EXEC sp_OASetProperty @json, 'I', @i
DECLARE @title nvarchar(4000)
EXEC sp_OAMethod @json, 'StringOf', @title OUT, 'd.results[i].Title'
DECLARE @uri nvarchar(4000)
EXEC sp_OAMethod @json, 'StringOf', @uri OUT, 'd.results[i].__metadata.uri'
PRINT @i + 1 + ': ' + @title
-- This is the URI for the Nth item in this list
PRINT 'URI: ' + @uri
SELECT @i = @i + 1
END
-- My output when testing is like what is shown below.
-- I found that not every item has a Title, but as viewed in a browser, I can see each of the item's name.
-- (The number of items agrees with what I can interactively see in a browser.) The mystery of what
-- is being shown for the name (or title) in the browser will be investigated further as Chilkat
-- continues to explore the SharePoint API...
-- Number of Items in this SharePoint List = 13
-- 1: Domain Name created for Exchange Docx
-- URI: https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/Items(3)
-- 2: null
-- URI: https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/Items(4)
-- 3: VCAC_RA_Design.docx
-- URI: https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/Items(5)
-- 4: null
-- URI: https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/Items(9)
-- 5: null
-- URI: https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/Items(10)
-- 6: Architecture Briefv1
-- URI: https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/Items(16)
-- 7: PowerPoint Presentation
-- URI: https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/Items(17)
-- 8: null
-- URI: https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/Items(18)
-- 9: null
-- URI: https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/Items(19)
-- 10: null
-- URI: https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/Items(20)
-- 11: FRC Summit Brief
-- URI: https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/Items(21)
-- 12: VCAC DISA Brief 8-13-16
-- URI: https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/Items(22)
-- 13: TEST PROCEDURE
-- URI: https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/Items(23)
--
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbJson
EXEC @hr = sp_OADestroy @json
END
GO