PowerBuilder

SharePoint -- Create List

See more SharePoint Examples

This example shows how to create a new SharePoint list. PowerBuilder

integer li_rc
integer li_Success
oleobject loo_Http
oleobject loo_Req
oleobject loo_Json
integer li_BUseTls
oleobject loo_Resp

li_Success = 0

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

loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

// If SharePoint Windows classic authentication is used, then set the 
// Login, Password, LoginDomain, and NtlmAuth properties.
loo_Http.Login = "SHAREPOINT_USERNAME"
loo_Http.Password = "SHAREPOINT_PASSWORD"
loo_Http.LoginDomain = "SHAREPOINT_NTLM_DOMAIN"
loo_Http.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

loo_Req = create oleobject
li_rc = loo_Req.ConnectToNewObject("Chilkat.HttpRequest")

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

// Set the Content-Type, and indicate that a JSON response is desired.
loo_Req.ContentType = "application/json;odata=verbose"
loo_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
loo_Json = create oleobject
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")

loo_Json.UpdateString("__metadata.type","SP.List")
loo_Json.UpdateBool("AllowContentTypes",1)
loo_Json.UpdateInt("BaseTemplate",100)
loo_Json.UpdateBool("ContentTypesEnabled",1)
loo_Json.UpdateString("Description","My list description")
loo_Json.UpdateString("Title","Test")

// Send the POST using HTTPS (TLS). Port 443 is the default port for https.
li_BUseTls = 1
loo_Resp = create oleobject
li_rc = loo_Resp.ConnectToNewObject("Chilkat.HttpResponse")

li_Success = loo_Http.HttpSReq("SHAREPOINT_HTTPS_DOMAIN",443,li_BUseTls,loo_Req,loo_Resp)
if li_Success = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_Req
    destroy loo_Json
    destroy loo_Resp
    return
end if

// The response body contains JSON.
loo_Json.Load(loo_Resp.BodyStr)
loo_Json.EmitCompact = 0

// The expected success response code is 201.
// (Let's also check for 200, just in case things change..)
if (loo_Resp.StatusCode <> 200) AND (loo_Resp.StatusCode <> 201) then
    Write-Debug "Response status code = " + string(loo_Resp.StatusCode)
    Write-Debug loo_Json.Emit()
    Write-Debug "Failed"
    destroy loo_Http
    destroy loo_Req
    destroy loo_Json
    destroy loo_Resp
    return
end if

// Show the successful JSON response.
Write-Debug loo_Json.Emit()
Write-Debug "Success."

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


destroy loo_Http
destroy loo_Req
destroy loo_Json
destroy loo_Resp