(PureBasic) 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 PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkHttpResponse.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttpRequest.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; If SharePoint Windows classic authentication is used, then set the 
    ; Login, Password, LoginDomain, and NtlmAuth properties.
    CkHttp::setCkLogin(http, "SHAREPOINT_USERNAME")
    CkHttp::setCkPassword(http, "SHAREPOINT_PASSWORD")
    CkHttp::setCkLoginDomain(http, "SHAREPOINT_NTLM_DOMAIN")
    CkHttp::setCkNtlmAuth(http, 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.
    CkHttp::ckSetRequestHeader(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.s = CkHttp::ckQuickGetStr(http,"https://SHAREPOINT_HTTPS_DOMAIN/_api/web/GetFolderByServerRelativeUrl('/Documents/ChilkatTest')/ListItemAllFields")
    If CkHttp::ckLastMethodSuccess(http) <> 1
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        ProcedureReturn
    EndIf

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoad(json,sAllFields)
    CkJsonObject::setCkEmitCompact(json, 0)

    Debug CkJsonObject::ckEmit(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.i = CkStringBuilder::ckCreate()
    If sbPath.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStringBuilder::ckAppend(sbPath,"/_api/")
    CkStringBuilder::ckAppend(sbPath,CkJsonObject::ckStringOf(json,"d.__metadata.id"))

    req.i = CkHttpRequest::ckCreate()
    If req.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkHttpRequest::setCkHttpVerb(req, "POST")
    CkHttpRequest::setCkPath(req, CkStringBuilder::ckGetAsString(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::ckAddHeader(req,"X-RequestDigest","SHAREPOINT_FORM_DIGEST")

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

    ; We need a few more headers...
    CkHttpRequest::ckAddHeader(req,"IF-MATCH",CkJsonObject::ckStringOf(json,"d.__metadata.etag"))
    CkHttpRequest::ckAddHeader(req,"X-HTTP-Method","MERGE")

    ; Create and add the JSON body.
    jsonBody.i = CkJsonObject::ckCreate()
    If jsonBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(jsonBody,"__metadata.type",CkJsonObject::ckStringOf(json,"d.__metadata.type"))
    CkJsonObject::ckUpdateString(jsonBody,"Title","ChilkatTest2")
    CkJsonObject::ckUpdateString(jsonBody,"FileLeafRef","ChilkatTest2")
    CkHttpRequest::ckLoadBodyFromString(req,CkJsonObject::ckEmit(jsonBody),"utf-8")

    ; Send the POST using HTTPS.
    bUseTls.i = 1
    resp.i = CkHttp::ckSynchronousRequest(http,"SHAREPOINT_HTTPS_DOMAIN",443,bUseTls,req)
    If CkHttp::ckLastMethodSuccess(http) <> 1
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbPath)
        CkHttpRequest::ckDispose(req)
        CkJsonObject::ckDispose(jsonBody)
        ProcedureReturn
    EndIf

    ; The response body contains JSON.
    ; When successful, it will be empty.
    CkJsonObject::ckLoad(json,CkHttpResponse::ckBodyStr(resp))
    CkJsonObject::setCkEmitCompact(json, 0)

    Debug "Response status code = " + Str(CkHttpResponse::ckStatusCode(resp))

    ; The expected success response code is 204.
    If CkHttpResponse::ckStatusCode(resp) <> 204
        Debug "Response status code = " + Str(CkHttpResponse::ckStatusCode(resp))
        Debug CkJsonObject::ckEmit(json)
        Debug "Failed"
        CkHttpResponse::ckDispose(resp)

        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        CkStringBuilder::ckDispose(sbPath)
        CkHttpRequest::ckDispose(req)
        CkJsonObject::ckDispose(jsonBody)
        ProcedureReturn
    EndIf

    CkHttpResponse::ckDispose(resp)

    ; The response body is empty for a 204 (success) response...
    Debug "Success."


    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbPath)
    CkHttpRequest::ckDispose(req)
    CkJsonObject::ckDispose(jsonBody)


    ProcedureReturn
EndProcedure