(Swift 3,4,5...) SharePoint -- Create List

See more SharePoint Examples

This example shows how to create a new SharePoint list.

For more information, see https://docs.microsoft.com/en-us/sharepoint/dev/sp-add-ins/working-with-lists-and-list-items-with-rest

Chilkat Downloads for the Swift Programming Language MAC OS X (Cocoa) Objective-C/Swift Libs iOS Objective-C/Swift Libs

func chilkatTest() {
    // 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 list, we're going to POST to
    // https://SHAREPOINT_HTTPS_DOMAIN/_api/web/lists
    // with a request body containing the following JSON:
    // 
    // {
    //   "__metadata": {
    //     "type": "SP.List"
    //   },
    //   "AllowContentTypes": true,
    //   "BaseTemplate": 100,
    //  "ContentTypesEnabled": true,
    //  "Description": "My list description",
    //  "Title": "Test"
    // }

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

    let req = CkoHttpRequest()!
    req.httpVerb = "POST"
    req.path = "/_api/web/lists"

    // 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("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("Accept", value: "application/json;odata=verbose")

    // Create and add the JSON body.
    // Use this online tool to generate code from sample JSON: 
    // Generate Code to Create JSON
    let json = CkoJsonObject()!
    json.update("__metadata.type", value: "SP.List")
    json.updateBool("AllowContentTypes", value: true)
    json.updateInt("BaseTemplate", value: 100)
    json.updateBool("ContentTypesEnabled", value: true)
    json.update("Description", value: "My list description")
    json.update("Title", value: "Test")

    // Send the POST using HTTPS (TLS). Port 443 is the default port for https.
    var bUseTls: Bool = true
    var resp: CkoHttpResponse? = http.synchronousRequest("SHAREPOINT_HTTPS_DOMAIN", port: 443, ssl: bUseTls, req: req)
    if http.lastMethodSuccess != true {
        print("\(http.lastErrorText!)")
        return
    }

    // The response body contains JSON.
    json.load(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")
        resp = nil
        return
    }

    resp = nil

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

    // Use this online tool to generate parsing code from sample JSON: 
    // Generate Parsing Code from JSON

}