(SQL Server) SharePoint -- Create List

See more SharePoint Examples

This example shows how to create a new SharePoint list.

For more information, see https://docs.microsoft.com/en-us/sharepoint/dev/sp-add-ins/working-with-lists-and-list-items-with-rest

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
    DECLARE @iTmp0 int
    DECLARE @iTmp1 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.

    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

    -- To create a list, we're going to POST to
    -- https://SHAREPOINT_HTTPS_DOMAIN/_api/web/lists
    -- with a request body containing the following JSON:
    -- 
    -- {
    --   "__metadata": {
    --     "type": "SP.List"
    --   },
    --   "AllowContentTypes": true,
    --   "BaseTemplate": 100,
    --  "ContentTypesEnabled": true,
    --  "Description": "My list description",
    --  "Title": "Test"
    -- }

    -- This example will create a folder named ChilkatTest in /Documents

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

    EXEC sp_OASetProperty @req, 'HttpVerb', 'POST'
    EXEC sp_OASetProperty @req, 'Path', '/_api/web/lists'

    -- We need to add a form digest value in the X-RequestDigest header field.
    -- See this example for details on
    -- how to get (and cache) a form digest value
    EXEC sp_OAMethod @req, 'AddHeader', NULL, 'X-RequestDigest', 'SHAREPOINT_FORM_DIGEST'

    -- Set the Content-Type, and indicate that a JSON response is desired.
    EXEC sp_OASetProperty @req, 'ContentType', 'application/json;odata=verbose'
    EXEC sp_OAMethod @req, 'AddHeader', NULL, 'Accept', 'application/json;odata=verbose'

    -- Create and add the JSON body.
    -- Use this online tool to generate code from sample JSON: 
    -- Generate Code to Create JSON
    DECLARE @json int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT

    DECLARE @success int
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, '__metadata.type', 'SP.List'
    EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'AllowContentTypes', 1
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'BaseTemplate', 100
    EXEC sp_OAMethod @json, 'UpdateBool', @success OUT, 'ContentTypesEnabled', 1
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'Description', 'My list description'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'Title', 'Test'

    -- Send the POST using HTTPS (TLS). Port 443 is the default port for https.
    DECLARE @bUseTls int
    SELECT @bUseTls = 1
    DECLARE @resp int
    EXEC sp_OAMethod @http, 'SynchronousRequest', @resp OUT, 'SHAREPOINT_HTTPS_DOMAIN', 443, @bUseTls, @req
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 <> 1
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @req
        EXEC @hr = sp_OADestroy @json
        RETURN
      END

    -- The response body contains JSON.
    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    EXEC sp_OAMethod @json, 'Load', @success OUT, @sTmp0
    EXEC sp_OASetProperty @json, 'EmitCompact', 0

    -- The expected success response code is 201.
    -- (Let's also check for 200, just in case things change..)
    EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
    EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp1 OUT
    IF (@iTmp0 <> 200) and (@iTmp1 <> 201)
      BEGIN

        EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
        PRINT 'Response status code = ' + @iTmp0
        EXEC sp_OAMethod @json, 'Emit', @sTmp0 OUT
        PRINT @sTmp0

        PRINT 'Failed'
        EXEC @hr = sp_OADestroy @resp

        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @req
        EXEC @hr = sp_OADestroy @json
        RETURN
      END

    EXEC @hr = sp_OADestroy @resp

    -- Show the successful JSON response.
    EXEC sp_OAMethod @json, 'Emit', @sTmp0 OUT
    PRINT @sTmp0

    PRINT 'Success.'

    -- Use this online tool to generate parsing code from sample JSON: 
    -- Generate Parsing Code from JSON

    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @req
    EXEC @hr = sp_OADestroy @json


END
GO