(Tcl) 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 Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

set http [new_CkHttp]

# If SharePoint Windows classic authentication is used, then set the 
# Login, Password, LoginDomain, and NtlmAuth properties.
CkHttp_put_Login $http "SHAREPOINT_USERNAME"
CkHttp_put_Password $http "SHAREPOINT_PASSWORD"
CkHttp_put_LoginDomain $http "SHAREPOINT_NTLM_DOMAIN"
CkHttp_put_NtlmAuth $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

# 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

set req [new_CkHttpRequest]

CkHttpRequest_put_HttpVerb $req "POST"
CkHttpRequest_put_Path $req "/_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
CkHttpRequest_AddHeader $req "X-RequestDigest" "SHAREPOINT_FORM_DIGEST"

# Set the Content-Type, and indicate that a JSON response is desired.
CkHttpRequest_put_ContentType $req "application/json;odata=verbose"
CkHttpRequest_AddHeader $req "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
set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "__metadata.type" "SP.List"
CkJsonObject_UpdateBool $json "AllowContentTypes" 1
CkJsonObject_UpdateInt $json "BaseTemplate" 100
CkJsonObject_UpdateBool $json "ContentTypesEnabled" 1
CkJsonObject_UpdateString $json "Description" "My list description"
CkJsonObject_UpdateString $json "Title" "Test"

# Send the POST using HTTPS (TLS). Port 443 is the default port for https.
set bUseTls 1
# resp is a CkHttpResponse
set resp [CkHttp_SynchronousRequest $http "SHAREPOINT_HTTPS_DOMAIN" 443 $bUseTls $req]
if {[CkHttp_get_LastMethodSuccess $http] != 1} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkHttpRequest $req
    delete_CkJsonObject $json
    exit
}

# The response body contains JSON.
CkJsonObject_Load $json [CkHttpResponse_bodyStr $resp]
CkJsonObject_put_EmitCompact $json 0

# The expected success response code is 201.
# (Let's also check for 200, just in case things change..)
if {expr [[CkHttpResponse_get_StatusCode $resp] != 200]  &&  [[CkHttpResponse_get_StatusCode $resp] != 201]} then {
    puts "Response status code = [CkHttpResponse_get_StatusCode $resp]"
    puts [CkJsonObject_emit $json]
    puts "Failed"
    delete_CkHttpResponse $resp

    delete_CkHttp $http
    delete_CkHttpRequest $req
    delete_CkJsonObject $json
    exit
}

delete_CkHttpResponse $resp

# Show the successful JSON response.
puts [CkJsonObject_emit $json]
puts "Success."

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

delete_CkHttp $http
delete_CkHttpRequest $req
delete_CkJsonObject $json