Swift

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.

Swift

func chilkatTest() {
    var success: Bool = false

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

    let http = CkoHttp()!

    // If SharePoint Windows classic authentication is used, then set the 
    // Login, Password, LoginDomain, and NtlmAuth properties.
    http.login = "SHAREPOINT_USERNAME"
    http.password = "SHAREPOINT_PASSWORD"
    http.loginDomain = "SHAREPOINT_NTLM_DOMAIN"
    http.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(name: "Accept", value: "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.
    var sAllFields: String? = http.quickGetStr(url: "https://SHAREPOINT_HTTPS_DOMAIN/_api/web/GetFolderByServerRelativeUrl('/Documents/ChilkatTest')/ListItemAllFields")
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    let json = CkoJsonObject()!
    json.load(json: sAllFields)
    json.emitCompact = false

    print("\(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.
    let sbPath = CkoStringBuilder()!
    sbPath.append(value: "/_api/")
    sbPath.append(value: json.string(of: "d.__metadata.id"))

    let req = CkoHttpRequest()!
    req.httpVerb = "POST"
    req.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(name: "X-RequestDigest", value: "SHAREPOINT_FORM_DIGEST")

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

    // We need a few more headers...
    req.addHeader(name: "IF-MATCH", value: json.string(of: "d.__metadata.etag"))
    req.addHeader(name: "X-HTTP-Method", value: "MERGE")

    // Create and add the JSON body.
    let jsonBody = CkoJsonObject()!
    jsonBody.updateString(jsonPath: "__metadata.type", value: json.string(of: "d.__metadata.type"))
    jsonBody.updateString(jsonPath: "Title", value: "ChilkatTest2")
    jsonBody.updateString(jsonPath: "FileLeafRef", value: "ChilkatTest2")
    req.loadBody(fromString: jsonBody.emit(), charset: "utf-8")

    // Send the POST using HTTPS.
    var bUseTls: Bool = true
    let resp = CkoHttpResponse()!
    success = http.httpSReq(domain: "SHAREPOINT_HTTPS_DOMAIN", port: 443, ssl: bUseTls, request: req, response: resp)
    if success == false {
        print("\(http.lastErrorText!)")
        return
    }

    // The response body contains JSON.
    // When successful, it will be empty.
    json.load(json: resp.bodyStr)
    json.emitCompact = false

    print("Response status code = \(resp.statusCode.intValue)")

    // The expected success response code is 204.
    if resp.statusCode.intValue != 204 {
        print("Response status code = \(resp.statusCode.intValue)")
        print("\(json.emit()!)")
        print("Failed")
        return
    }

    // The response body is empty for a 204 (success) response...
    print("Success.")

}