Swift

SharePoint -- Create Folder

See more SharePoint Examples

This example shows how to create a new SharePoint folder. 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

    // To create a folder, we're going to POST to
    // https://SHAREPOINT_HTTPS_DOMAIN/_api/web/folders
    // with a request body containing the following JSON:
    // 
    //     { "__metadata": { "type": "SP.Folder" }, "ServerRelativeUrl": "/document_library_relative_url/newFolderName"}

    // This example will create a folder named ChilkatTest in /Documents

    // Note: if your Sharepoint site is within a site collection, you must add the site name "/sites/teamA" to both the Path and the ServerRelativeUrl

    let req = CkoHttpRequest()!
    req.httpVerb = "POST"
    // If your Sharepoint site is within a site collection, then use "/sites/teamA/_api/web/folders" where "teamA" is the name of the site.
    req.path = "/_api/web/folders"

    // 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")

    // Create and add the JSON body.
    let json = CkoJsonObject()!
    json.updateString(jsonPath: "__metadata.type", value: "SP.Folder")
    // If your Sharepoint site is within a site collection, then use "/sites/teamA/Documents/ChilkatTest" where "teamA" is the name of the site.
    json.updateString(jsonPath: "ServerRelativeUrl", value: "/Documents/ChilkatTest")
    req.loadBody(fromString: json.emit(), charset: "utf-8")

    // Send the POST using HTTPS (TLS). Port 443 is the default port for 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.
    json.load(json: resp.bodyStr)
    json.emitCompact = false

    // The expected success response code is 201.
    // (Let's also check for 200, just in case things change..)
    if (resp.statusCode.intValue != 200) && (resp.statusCode.intValue != 201) {
        print("Response status code = \(resp.statusCode.intValue)")
        print("\(json.emit()!)")
        print("Failed")
        return
    }

    // Show the successful JSON response.
    print("\(json.emit()!)")
    print("Success.")

    // A successful JSON response looks like this:

    // { 
    //   "d": { 
    //     "__metadata": { 
    //       "id": "Web/GetFolderByServerRelativeUrl('/Documents/ChilkatTest')",
    //       "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFolderByServerRelativeUrl('/Documents/ChilkatTest')",
    //       "type": "SP.Folder"
    //     },
    //     "Files": { 
    //       "__deferred": { 
    //         "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFolderByServerRelativeUrl('/Documents/ChilkatTest')/Files"
    //       }
    //     },
    //     "ListItemAllFields": { 
    //       "__deferred": { 
    //         "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFolderByServerRelativeUrl('/Documents/ChilkatTest')/ListItemAllFields"
    //       }
    //     },
    //     "ParentFolder": { 
    //       "__deferred": { 
    //         "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFolderByServerRelativeUrl('/Documents/ChilkatTest')/ParentFolder"
    //       }
    //     },
    //     "Properties": { 
    //       "__deferred": { 
    //         "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFolderByServerRelativeUrl('/Documents/ChilkatTest')/Properties"
    //       }
    //     },
    //     "Folders": { 
    //       "__deferred": { 
    //         "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFolderByServerRelativeUrl('/Documents/ChilkatTest')/Folders"
    //       }
    //     },
    //     "ItemCount": 0,
    //     "Name": "ChilkatTest",
    //     "ServerRelativeUrl": "/Documents/ChilkatTest",
    //     "WelcomePage": ""
    //   }
    // }

}