Unicode C
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.
Chilkat Unicode C Downloads
#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkHttpRequestW.h>
#include <C_CkHttpResponseW.h>
void ChilkatSample(void)
{
BOOL success;
HCkHttpW http;
const wchar_t *sAllFields;
HCkJsonObjectW json;
HCkStringBuilderW sbPath;
HCkHttpRequestW req;
HCkJsonObjectW jsonBody;
BOOL bUseTls;
HCkHttpResponseW resp;
success = FALSE;
// This requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_Create();
// If SharePoint Windows classic authentication is used, then set the
// Login, Password, LoginDomain, and NtlmAuth properties.
CkHttpW_putLogin(http,L"SHAREPOINT_USERNAME");
CkHttpW_putPassword(http,L"SHAREPOINT_PASSWORD");
CkHttpW_putLoginDomain(http,L"SHAREPOINT_NTLM_DOMAIN");
CkHttpW_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.
CkHttpW_SetRequestHeader(http,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.
sAllFields = CkHttpW_quickGetStr(http,L"https://SHAREPOINT_HTTPS_DOMAIN/_api/web/GetFolderByServerRelativeUrl('/Documents/ChilkatTest')/ListItemAllFields");
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
return;
}
json = CkJsonObjectW_Create();
CkJsonObjectW_Load(json,sAllFields);
CkJsonObjectW_putEmitCompact(json,FALSE);
wprintf(L"%s\n",CkJsonObjectW_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 = CkStringBuilderW_Create();
CkStringBuilderW_Append(sbPath,L"/_api/");
CkStringBuilderW_Append(sbPath,CkJsonObjectW_stringOf(json,L"d.__metadata.id"));
req = CkHttpRequestW_Create();
CkHttpRequestW_putHttpVerb(req,L"POST");
CkHttpRequestW_putPath(req,CkStringBuilderW_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
CkHttpRequestW_AddHeader(req,L"X-RequestDigest",L"SHAREPOINT_FORM_DIGEST");
// Set the Content-Type, and indicate that a JSON response is desired.
CkHttpRequestW_putContentType(req,L"application/json;odata=verbose");
CkHttpRequestW_AddHeader(req,L"Accept",L"application/json;odata=verbose");
// We need a few more headers...
CkHttpRequestW_AddHeader(req,L"IF-MATCH",CkJsonObjectW_stringOf(json,L"d.__metadata.etag"));
CkHttpRequestW_AddHeader(req,L"X-HTTP-Method",L"MERGE");
// Create and add the JSON body.
jsonBody = CkJsonObjectW_Create();
CkJsonObjectW_UpdateString(jsonBody,L"__metadata.type",CkJsonObjectW_stringOf(json,L"d.__metadata.type"));
CkJsonObjectW_UpdateString(jsonBody,L"Title",L"ChilkatTest2");
CkJsonObjectW_UpdateString(jsonBody,L"FileLeafRef",L"ChilkatTest2");
CkHttpRequestW_LoadBodyFromString(req,CkJsonObjectW_emit(jsonBody),L"utf-8");
// Send the POST using HTTPS.
bUseTls = TRUE;
resp = CkHttpResponseW_Create();
success = CkHttpW_HttpSReq(http,L"SHAREPOINT_HTTPS_DOMAIN",443,bUseTls,req,resp);
if (success == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbPath);
CkHttpRequestW_Dispose(req);
CkJsonObjectW_Dispose(jsonBody);
CkHttpResponseW_Dispose(resp);
return;
}
// The response body contains JSON.
// When successful, it will be empty.
CkJsonObjectW_Load(json,CkHttpResponseW_bodyStr(resp));
CkJsonObjectW_putEmitCompact(json,FALSE);
wprintf(L"Response status code = %d\n",CkHttpResponseW_getStatusCode(resp));
// The expected success response code is 204.
if (CkHttpResponseW_getStatusCode(resp) != 204) {
wprintf(L"Response status code = %d\n",CkHttpResponseW_getStatusCode(resp));
wprintf(L"%s\n",CkJsonObjectW_emit(json));
wprintf(L"Failed\n");
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbPath);
CkHttpRequestW_Dispose(req);
CkJsonObjectW_Dispose(jsonBody);
CkHttpResponseW_Dispose(resp);
return;
}
// The response body is empty for a 204 (success) response...
wprintf(L"Success.\n");
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(json);
CkStringBuilderW_Dispose(sbPath);
CkHttpRequestW_Dispose(req);
CkJsonObjectW_Dispose(jsonBody);
CkHttpResponseW_Dispose(resp);
}