PowerBuilder

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.

PowerBuilder

integer li_rc
integer li_Success
oleobject loo_Http
string ls_SAllFields
oleobject loo_Json
oleobject loo_SbPath
oleobject loo_Req
oleobject loo_JsonBody
integer li_BUseTls
oleobject loo_Resp

li_Success = 0

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

loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// If SharePoint Windows classic authentication is used, then set the 
// Login, Password, LoginDomain, and NtlmAuth properties.
loo_Http.Login = "SHAREPOINT_USERNAME"
loo_Http.Password = "SHAREPOINT_PASSWORD"
loo_Http.LoginDomain = "SHAREPOINT_NTLM_DOMAIN"
loo_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.
loo_Http.SetRequestHeader("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.
ls_SAllFields = loo_Http.QuickGetStr("https://SHAREPOINT_HTTPS_DOMAIN/_api/web/GetFolderByServerRelativeUrl('/Documents/ChilkatTest')/ListItemAllFields")
if loo_Http.LastMethodSuccess = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    return
end if

loo_Json = create oleobject
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")

loo_Json.Load(ls_SAllFields)
loo_Json.EmitCompact = 0

Write-Debug loo_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.
loo_SbPath = create oleobject
li_rc = loo_SbPath.ConnectToNewObject("Chilkat.StringBuilder")

loo_SbPath.Append("/_api/")
loo_SbPath.Append(loo_Json.StringOf("d.__metadata.id"))

loo_Req = create oleobject
li_rc = loo_Req.ConnectToNewObject("Chilkat.HttpRequest")

loo_Req.HttpVerb = "POST"
loo_Req.Path = loo_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
loo_Req.AddHeader("X-RequestDigest","SHAREPOINT_FORM_DIGEST")

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

// We need a few more headers...
loo_Req.AddHeader("IF-MATCH",loo_Json.StringOf("d.__metadata.etag"))
loo_Req.AddHeader("X-HTTP-Method","MERGE")

// Create and add the JSON body.
loo_JsonBody = create oleobject
li_rc = loo_JsonBody.ConnectToNewObject("Chilkat.JsonObject")

loo_JsonBody.UpdateString("__metadata.type",loo_Json.StringOf("d.__metadata.type"))
loo_JsonBody.UpdateString("Title","ChilkatTest2")
loo_JsonBody.UpdateString("FileLeafRef","ChilkatTest2")
loo_Req.LoadBodyFromString(loo_JsonBody.Emit(),"utf-8")

// Send the POST using HTTPS.
li_BUseTls = 1
loo_Resp = create oleobject
li_rc = loo_Resp.ConnectToNewObject("Chilkat.HttpResponse")

li_Success = loo_Http.HttpSReq("SHAREPOINT_HTTPS_DOMAIN",443,li_BUseTls,loo_Req,loo_Resp)
if li_Success = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_Json
    destroy loo_SbPath
    destroy loo_Req
    destroy loo_JsonBody
    destroy loo_Resp
    return
end if

// The response body contains JSON.
// When successful, it will be empty.
loo_Json.Load(loo_Resp.BodyStr)
loo_Json.EmitCompact = 0

Write-Debug "Response status code = " + string(loo_Resp.StatusCode)

// The expected success response code is 204.
if loo_Resp.StatusCode <> 204 then
    Write-Debug "Response status code = " + string(loo_Resp.StatusCode)
    Write-Debug loo_Json.Emit()
    Write-Debug "Failed"
    destroy loo_Http
    destroy loo_Json
    destroy loo_SbPath
    destroy loo_Req
    destroy loo_JsonBody
    destroy loo_Resp
    return
end if

// The response body is empty for a 204 (success) response...
Write-Debug "Success."


destroy loo_Http
destroy loo_Json
destroy loo_SbPath
destroy loo_Req
destroy loo_JsonBody
destroy loo_Resp