(SQL Server) SharePoint -- Rename Folder

This example shows how to rename SharePoint folder.

Renaming a folder is not straightforward. Apparently, the information published by Microsoft is incorrect and simply doesn't work (the information about how to update a folder by using the MERGE method is incorrect).

To rename a folder requires two steps, as demonstrated by this example.

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

    -- The first step in renaming a file is send a GET to the /ListItemAllFields endpoint:
    -- Indicate we want a JSON response.
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json;odata=verbose'

    -- In this example, we want to rename the folder "/Documents/ChilkatTest" to "/Documents/ChilkatTest2"
    -- If your Sharepoint site is within a site collection, then use "https://SHAREPOINT_HTTPS_DOMAIN/sites/teamA/_api/web/GetFolderByServerRelativeUrl('/sites/teamA/Documents/ChilkatTest')/ListItemAllFields" where "teamA" is the name of the site.
    DECLARE @sAllFields nvarchar(4000)
    EXEC sp_OAMethod @http, 'QuickGetStr', @sAllFields OUT, 'https://SHAREPOINT_HTTPS_DOMAIN/_api/web/GetFolderByServerRelativeUrl(''/Documents/ChilkatTest'')/ListItemAllFields'
    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
        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

    DECLARE @success int
    EXEC sp_OAMethod @json, 'Load', @success OUT, @sAllFields
    EXEC sp_OASetProperty @json, 'EmitCompact', 0

    EXEC sp_OAMethod @json, 'Emit', @sTmp0 OUT
    PRINT @sTmp0

    -- The JSON response will look like this:
    -- We'll need to get the "id", "etag", and "type" for the next step.  The "id" for the
    -- sample below is "Web/Lists(guid'b0d92cec-4be1-4e52-943d-ebcb432e1c3b')/Items(62)"

    -- 
    -- { 
    --   "d": { 
    --     "__metadata": { 
    --       "id": "Web/Lists(guid'b0d92cec-4be1-4e52-943d-ebcb432e1c3b')/Items(62)",
    --       "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/Lists(guid'b0d92cec-4be1-4e52-943d-ebcb432e1c3b')/Items(62)",
    --       "etag": "\"4\"",
    --       "type": "SP.Data.DocumentsItem"
    --     },
    --     ...
    --     ...
    --     "FileSystemObjectType": 1,
    --     "Id": 62,
    --     "ContentTypeId": "0x012000FA905915D7D8F7458C1A0AF1E981BFF5",
    --     "Title": "ChilkatTest",
    --     "OData__dlc_DocId": null,
    --     "OData__dlc_DocIdUrl": null,
    --     "URL": null,
    --     "DocumentSetDescription": null,
    --     "EditorId": 25,
    --     "ID": 62,
    --     "Created": "2017-04-12T19:18:29",
    --     "AuthorId": 25,
    --     "Modified": "2017-04-12T19:49:15",
    --     "OData__CopySource": null,
    --     "CheckoutUserId": null,
    --     "OData__UIVersionString": "1.0",
    --     "GUID": "71f30f44-e33a-48e7-b4d8-9d619ba1ad69"
    --   }
    -- }

    -- -------------------------------------------------------------------------------
    -- Step 2...

    -- To rename a folder, we're going to POST to
    -- https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/Lists(guid'b0d92cec-4be1-4e52-943d-ebcb432e1c3b')/Items(62)
    -- with a request body containing the following JSON:
    -- 
    --     { "__metadata": { "type": "THE_TYPE_FROM_ABOVE" }, "Title": "New title", "FileLeafRef": "New title"}
    -- 

    -- Build the Path, which is "/_api/" + the id from above.
    DECLARE @sbPath int
    -- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbPath OUT

    EXEC sp_OAMethod @sbPath, 'Append', @success OUT, '/_api/'
    EXEC sp_OAMethod @json, 'StringOf', @sTmp0 OUT, 'd.__metadata.id'
    EXEC sp_OAMethod @sbPath, 'Append', @success OUT, @sTmp0

    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_OAMethod @sbPath, 'GetAsString', @sTmp0 OUT
    EXEC sp_OASetProperty @req, 'Path', @sTmp0

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

    -- We need a few more headers...
    EXEC sp_OAMethod @json, 'StringOf', @sTmp0 OUT, 'd.__metadata.etag'
    EXEC sp_OAMethod @req, 'AddHeader', NULL, 'IF-MATCH', @sTmp0
    EXEC sp_OAMethod @req, 'AddHeader', NULL, 'X-HTTP-Method', 'MERGE'

    -- Create and add the JSON body.
    DECLARE @jsonBody int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jsonBody OUT

    EXEC sp_OAMethod @json, 'StringOf', @sTmp0 OUT, 'd.__metadata.type'
    EXEC sp_OAMethod @jsonBody, 'UpdateString', @success OUT, '__metadata.type', @sTmp0
    EXEC sp_OAMethod @jsonBody, 'UpdateString', @success OUT, 'Title', 'ChilkatTest2'
    EXEC sp_OAMethod @jsonBody, 'UpdateString', @success OUT, 'FileLeafRef', 'ChilkatTest2'
    EXEC sp_OAMethod @jsonBody, 'Emit', @sTmp0 OUT
    EXEC sp_OAMethod @req, 'LoadBodyFromString', @success OUT, @sTmp0, 'utf-8'

    -- Send the POST using 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 @json
        EXEC @hr = sp_OADestroy @sbPath
        EXEC @hr = sp_OADestroy @req
        EXEC @hr = sp_OADestroy @jsonBody
        RETURN
      END

    -- The response body contains JSON.
    -- When successful, it will be empty.
    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    EXEC sp_OAMethod @json, 'Load', @success OUT, @sTmp0
    EXEC sp_OASetProperty @json, 'EmitCompact', 0


    EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
    PRINT 'Response status code = ' + @iTmp0

    -- The expected success response code is 204.
    EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
    IF @iTmp0 <> 204
      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 @json
        EXEC @hr = sp_OADestroy @sbPath
        EXEC @hr = sp_OADestroy @req
        EXEC @hr = sp_OADestroy @jsonBody
        RETURN
      END

    EXEC @hr = sp_OADestroy @resp

    -- The response body is empty for a 204 (success) response...

    PRINT 'Success.'

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


END
GO