(Perl) 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 Perl Downloads Perl Module for Windows, MacOS, Linux, Alpine Linux, Solaris

use chilkat();

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

$http = chilkat::CkHttp->new();

# If SharePoint Windows classic authentication is used, then set the 
# Login, Password, LoginDomain, and NtlmAuth properties.
$http->put_Login("SHAREPOINT_USERNAME");
$http->put_Password("SHAREPOINT_PASSWORD");
$http->put_LoginDomain("SHAREPOINT_NTLM_DOMAIN");
$http->put_NtlmAuth(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

$req = chilkat::CkHttpRequest->new();
$req->put_HttpVerb("POST");
$req->put_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->put_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
$json = chilkat::CkJsonObject->new();
$json->UpdateString("__metadata.type","SP.List");
$json->UpdateBool("AllowContentTypes",1);
$json->UpdateInt("BaseTemplate",100);
$json->UpdateBool("ContentTypesEnabled",1);
$json->UpdateString("Description","My list description");
$json->UpdateString("Title","Test");

# Send the POST using HTTPS (TLS). Port 443 is the default port for https.
$bUseTls = 1;
# resp is a HttpResponse
$resp = $http->SynchronousRequest("SHAREPOINT_HTTPS_DOMAIN",443,$bUseTls,$req);
if ($http->get_LastMethodSuccess() != 1) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

# The response body contains JSON.
$json->Load($resp->bodyStr());
$json->put_EmitCompact(0);

# The expected success response code is 201.
# (Let's also check for 200, just in case things change..)
if (($resp->get_StatusCode() != 200) and ($resp->get_StatusCode() != 201)) {
    print "Response status code = " . $resp->get_StatusCode() . "\r\n";
    print $json->emit() . "\r\n";
    print "Failed" . "\r\n";

    exit;
}

# Show the successful JSON response.
print $json->emit() . "\r\n";
print "Success." . "\r\n";

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