Unicode C++

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.

Unicode C++

#include <CkHttpW.h>
#include <CkJsonObjectW.h>
#include <CkStringBuilderW.h>
#include <CkHttpRequestW.h>
#include <CkHttpResponseW.h>

void ChilkatSample(void)
    {
    bool success = false;

    //  This requires the Chilkat API to have been previously unlocked.
    //  See Global Unlock Sample for sample code.

    CkHttpW http;

    //  If SharePoint Windows classic authentication is used, then set the 
    //  Login, Password, LoginDomain, and NtlmAuth properties.
    http.put_Login(L"SHAREPOINT_USERNAME");
    http.put_Password(L"SHAREPOINT_PASSWORD");
    http.put_LoginDomain(L"SHAREPOINT_NTLM_DOMAIN");
    http.put_NtlmAuth(true);

    //  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.
    http.SetRequestHeader(L"Accept",L"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.
    const wchar_t *sAllFields = http.quickGetStr(L"https://SHAREPOINT_HTTPS_DOMAIN/_api/web/GetFolderByServerRelativeUrl('/Documents/ChilkatTest')/ListItemAllFields");
    if (http.get_LastMethodSuccess() == false) {
        wprintf(L"%s\n",http.lastErrorText());
        return;
    }

    CkJsonObjectW json;
    json.Load(sAllFields);
    json.put_EmitCompact(false);

    wprintf(L"%s\n",json.emit());

    //  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.
    CkStringBuilderW sbPath;
    sbPath.Append(L"/_api/");
    sbPath.Append(json.stringOf(L"d.__metadata.id"));

    CkHttpRequestW req;
    req.put_HttpVerb(L"POST");
    req.put_Path(sbPath.getAsString());

    //  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
    req.AddHeader(L"X-RequestDigest",L"SHAREPOINT_FORM_DIGEST");

    //  Set the Content-Type, and indicate that a JSON response is desired.
    req.put_ContentType(L"application/json;odata=verbose");
    req.AddHeader(L"Accept",L"application/json;odata=verbose");

    //  We need a few more headers...
    req.AddHeader(L"IF-MATCH",json.stringOf(L"d.__metadata.etag"));
    req.AddHeader(L"X-HTTP-Method",L"MERGE");

    //  Create and add the JSON body.
    CkJsonObjectW jsonBody;
    jsonBody.UpdateString(L"__metadata.type",json.stringOf(L"d.__metadata.type"));
    jsonBody.UpdateString(L"Title",L"ChilkatTest2");
    jsonBody.UpdateString(L"FileLeafRef",L"ChilkatTest2");
    req.LoadBodyFromString(jsonBody.emit(),L"utf-8");

    //  Send the POST using HTTPS.
    bool bUseTls = true;
    CkHttpResponseW resp;
    success = http.HttpSReq(L"SHAREPOINT_HTTPS_DOMAIN",443,bUseTls,req,resp);
    if (success == false) {
        wprintf(L"%s\n",http.lastErrorText());
        return;
    }

    //  The response body contains JSON.
    //  When successful, it will be empty.
    json.Load(resp.bodyStr());
    json.put_EmitCompact(false);

    wprintf(L"Response status code = %d\n",resp.get_StatusCode());

    //  The expected success response code is 204.
    if (resp.get_StatusCode() != 204) {
        wprintf(L"Response status code = %d\n",resp.get_StatusCode());
        wprintf(L"%s\n",json.emit());
        wprintf(L"Failed\n");
        return;
    }

    //  The response body is empty for a 204 (success) response...
    wprintf(L"Success.\n");
    }