(Xojo Plugin) 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 Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

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

Dim http As New Chilkat.Http

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

Dim req As New Chilkat.HttpRequest
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","SHAREPOINT_FORM_DIGEST"

// Set the Content-Type, and indicate that a JSON response is desired.
req.ContentType = "application/json;odata=verbose"
req.AddHeader "Accept","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
Dim json As New Chilkat.JsonObject
Dim success As Boolean
success = json.UpdateString("__metadata.type","SP.List")
success = json.UpdateBool("AllowContentTypes",True)
success = json.UpdateInt("BaseTemplate",100)
success = json.UpdateBool("ContentTypesEnabled",True)
success = json.UpdateString("Description","My list description")
success = json.UpdateString("Title","Test")

// Send the POST using HTTPS (TLS). Port 443 is the default port for https.
Dim bUseTls As Boolean
bUseTls = True
Dim resp As Chilkat.HttpResponse
resp = http.SynchronousRequest("SHAREPOINT_HTTPS_DOMAIN",443,bUseTls,req)
If (http.LastMethodSuccess <> True) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

// The response body contains JSON.
success = 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 <> 200) And (resp.StatusCode <> 201)) Then
    System.DebugLog("Response status code = " + Str(resp.StatusCode))
    System.DebugLog(json.Emit())
    System.DebugLog("Failed")

    Return
End If

// Show the successful JSON response.
System.DebugLog(json.Emit())
System.DebugLog("Success.")

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