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.

C

#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkStringBuilder.h>
#include <C_CkHttpRequest.h>
#include <C_CkHttpResponse.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkHttp http;
    const char *sAllFields;
    HCkJsonObject json;
    HCkStringBuilder sbPath;
    HCkHttpRequest req;
    HCkJsonObject jsonBody;
    BOOL bUseTls;
    HCkHttpResponse resp;

    success = FALSE;

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

    http = CkHttp_Create();

    //  If SharePoint Windows classic authentication is used, then set the 
    //  Login, Password, LoginDomain, and NtlmAuth properties.
    CkHttp_putLogin(http,"SHAREPOINT_USERNAME");
    CkHttp_putPassword(http,"SHAREPOINT_PASSWORD");
    CkHttp_putLoginDomain(http,"SHAREPOINT_NTLM_DOMAIN");
    CkHttp_putNtlmAuth(http,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.
    CkHttp_SetRequestHeader(http,"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.
    sAllFields = CkHttp_quickGetStr(http,"https://SHAREPOINT_HTTPS_DOMAIN/_api/web/GetFolderByServerRelativeUrl('/Documents/ChilkatTest')/ListItemAllFields");
    if (CkHttp_getLastMethodSuccess(http) == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        return;
    }

    json = CkJsonObject_Create();
    CkJsonObject_Load(json,sAllFields);
    CkJsonObject_putEmitCompact(json,FALSE);

    printf("%s\n",CkJsonObject_emit(json));

    //  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.
    sbPath = CkStringBuilder_Create();
    CkStringBuilder_Append(sbPath,"/_api/");
    CkStringBuilder_Append(sbPath,CkJsonObject_stringOf(json,"d.__metadata.id"));

    req = CkHttpRequest_Create();
    CkHttpRequest_putHttpVerb(req,"POST");
    CkHttpRequest_putPath(req,CkStringBuilder_getAsString(sbPath));

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

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

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

    //  Create and add the JSON body.
    jsonBody = CkJsonObject_Create();
    CkJsonObject_UpdateString(jsonBody,"__metadata.type",CkJsonObject_stringOf(json,"d.__metadata.type"));
    CkJsonObject_UpdateString(jsonBody,"Title","ChilkatTest2");
    CkJsonObject_UpdateString(jsonBody,"FileLeafRef","ChilkatTest2");
    CkHttpRequest_LoadBodyFromString(req,CkJsonObject_emit(jsonBody),"utf-8");

    //  Send the POST using HTTPS.
    bUseTls = TRUE;
    resp = CkHttpResponse_Create();
    success = CkHttp_HttpSReq(http,"SHAREPOINT_HTTPS_DOMAIN",443,bUseTls,req,resp);
    if (success == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(json);
        CkStringBuilder_Dispose(sbPath);
        CkHttpRequest_Dispose(req);
        CkJsonObject_Dispose(jsonBody);
        CkHttpResponse_Dispose(resp);
        return;
    }

    //  The response body contains JSON.
    //  When successful, it will be empty.
    CkJsonObject_Load(json,CkHttpResponse_bodyStr(resp));
    CkJsonObject_putEmitCompact(json,FALSE);

    printf("Response status code = %d\n",CkHttpResponse_getStatusCode(resp));

    //  The expected success response code is 204.
    if (CkHttpResponse_getStatusCode(resp) != 204) {
        printf("Response status code = %d\n",CkHttpResponse_getStatusCode(resp));
        printf("%s\n",CkJsonObject_emit(json));
        printf("Failed\n");
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(json);
        CkStringBuilder_Dispose(sbPath);
        CkHttpRequest_Dispose(req);
        CkJsonObject_Dispose(jsonBody);
        CkHttpResponse_Dispose(resp);
        return;
    }

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


    CkHttp_Dispose(http);
    CkJsonObject_Dispose(json);
    CkStringBuilder_Dispose(sbPath);
    CkHttpRequest_Dispose(req);
    CkJsonObject_Dispose(jsonBody);
    CkHttpResponse_Dispose(resp);

    }