Delphi DLL

SharePoint -- Create List

See more SharePoint Examples

This example shows how to create a new SharePoint list. Delphi DLL

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Http, HttpRequest, HttpResponse, JsonObject;

...

procedure TForm1.Button1Click(Sender: TObject);
var
success: Boolean;
http: HCkHttp;
req: HCkHttpRequest;
json: HCkJsonObject;
bUseTls: Boolean;
resp: HCkHttpResponse;

begin
success := False;

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

http := CkHttp_Create();

// If SharePoint Windows classic authentication is used, then set the 
// Login, Password, LoginDomain, and NtlmAuth properties.
CkHttp_putLogin(http,'SHAREPOINT_USERNAME');
CkHttp_putPassword(http,'SHAREPOINT_PASSWORD');
CkHttp_putLoginDomain(http,'SHAREPOINT_NTLM_DOMAIN');
CkHttp_putNtlmAuth(http,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

req := CkHttpRequest_Create();
CkHttpRequest_putHttpVerb(req,'POST');
CkHttpRequest_putPath(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_putContentType(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
json := CkJsonObject_Create();
CkJsonObject_UpdateString(json,'__metadata.type','SP.List');
CkJsonObject_UpdateBool(json,'AllowContentTypes',True);
CkJsonObject_UpdateInt(json,'BaseTemplate',100);
CkJsonObject_UpdateBool(json,'ContentTypesEnabled',True);
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.
bUseTls := True;
resp := CkHttpResponse_Create();
success := CkHttp_HttpSReq(http,'SHAREPOINT_HTTPS_DOMAIN',443,bUseTls,req,resp);
if (success = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

// The response body contains JSON.
CkJsonObject_Load(json,CkHttpResponse__bodyStr(resp));
CkJsonObject_putEmitCompact(json,False);

// The expected success response code is 201.
// (Let's also check for 200, just in case things change..)
if ((CkHttpResponse_getStatusCode(resp) <> 200) and (CkHttpResponse_getStatusCode(resp) <> 201)) then
  begin
    Memo1.Lines.Add('Response status code = ' + IntToStr(CkHttpResponse_getStatusCode(resp)));
    Memo1.Lines.Add(CkJsonObject__emit(json));
    Memo1.Lines.Add('Failed');
    Exit;
  end;

// Show the successful JSON response.
Memo1.Lines.Add(CkJsonObject__emit(json));
Memo1.Lines.Add('Success.');

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

CkHttp_Dispose(http);
CkHttpRequest_Dispose(req);
CkJsonObject_Dispose(json);
CkHttpResponse_Dispose(resp);

end;