(JavaScript) SharePoint -- Create List

See more SharePoint Examples

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

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

var success = false;

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

var http = new CkHttp();

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

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

// Send the POST using HTTPS (TLS). Port 443 is the default port for https.
var bUseTls = true;
var resp = new CkHttpResponse();
success = http.HttpSReq("SHAREPOINT_HTTPS_DOMAIN",443,bUseTls,req,resp);
if (success == false) {
    console.log(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 !== 200) && (resp.StatusCode !== 201)) {
    console.log("Response status code = " + resp.StatusCode);
    console.log(json.Emit());
    console.log("Failed");
    return;
}

// Show the successful JSON response.
console.log(json.Emit());
console.log("Success.");

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