(Lianja) 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 Lianja Extension Download Chilkat Lianja Extension

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

loHttp = createobject("CkHttp")

// If SharePoint Windows classic authentication is used, then set the 
// Login, Password, LoginDomain, and NtlmAuth properties.
loHttp.Login = "SHAREPOINT_USERNAME"
loHttp.Password = "SHAREPOINT_PASSWORD"
loHttp.LoginDomain = "SHAREPOINT_NTLM_DOMAIN"
loHttp.NtlmAuth = .T.

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

loReq = createobject("CkHttpRequest")
loReq.HttpVerb = "POST"
loReq.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
loReq.AddHeader("X-RequestDigest","SHAREPOINT_FORM_DIGEST")

// Set the Content-Type, and indicate that a JSON response is desired.
loReq.ContentType = "application/json;odata=verbose"
loReq.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
loJson = createobject("CkJsonObject")
loJson.UpdateString("__metadata.type","SP.List")
loJson.UpdateBool("AllowContentTypes",.T.)
loJson.UpdateInt("BaseTemplate",100)
loJson.UpdateBool("ContentTypesEnabled",.T.)
loJson.UpdateString("Description","My list description")
loJson.UpdateString("Title","Test")

// Send the POST using HTTPS (TLS). Port 443 is the default port for https.
llBUseTls = .T.
loResp = loHttp.SynchronousRequest("SHAREPOINT_HTTPS_DOMAIN",443,llBUseTls,loReq)
if (loHttp.LastMethodSuccess <> .T.) then
    ? loHttp.LastErrorText
    release loHttp
    release loReq
    release loJson
    return
endif

// The response body contains JSON.
loJson.Load(loResp.BodyStr)
loJson.EmitCompact = .F.

// The expected success response code is 201.
// (Let's also check for 200, just in case things change..)
if ((loResp.StatusCode <> 200) and (loResp.StatusCode <> 201)) then
    ? "Response status code = " + str(loResp.StatusCode)
    ? loJson.Emit()
    ? "Failed"
    release loResp
    release loHttp
    release loReq
    release loJson
    return
endif

release loResp

// Show the successful JSON response.
? loJson.Emit()
? "Success."

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


release loHttp
release loReq
release loJson