(Objective-C) 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 Objective-C Library Downloads MAC OS X (Cocoa) Libs iOS Libs

#import <CkoHttp.h>
#import <CkoHttpRequest.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>

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

CkoHttp *http = [[CkoHttp alloc] init];

// 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 = YES;

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

CkoHttpRequest *req = [[CkoHttpRequest alloc] init];
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" value: @"SHAREPOINT_FORM_DIGEST"];

// Set the Content-Type, and indicate that a JSON response is desired.
req.ContentType = @"application/json;odata=verbose";
[req AddHeader: @"Accept" value: @"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
CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"__metadata.type" value: @"SP.List"];
[json UpdateBool: @"AllowContentTypes" value: YES];
[json UpdateInt: @"BaseTemplate" value: [NSNumber numberWithInt: 100]];
[json UpdateBool: @"ContentTypesEnabled" value: YES];
[json UpdateString: @"Description" value: @"My list description"];
[json UpdateString: @"Title" value: @"Test"];

// Send the POST using HTTPS (TLS). Port 443 is the default port for https.
BOOL bUseTls = YES;
CkoHttpResponse *resp = [http SynchronousRequest: @"SHAREPOINT_HTTPS_DOMAIN" port: [NSNumber numberWithInt: 443] ssl: bUseTls req: req];
if (http.LastMethodSuccess != YES) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

// The response body contains JSON.
[json Load: resp.BodyStr];
json.EmitCompact = NO;

// The expected success response code is 201.
// (Let's also check for 200, just in case things change..)
if (([resp.StatusCode intValue] != 200) && ([resp.StatusCode intValue] != 201)) {
    NSLog(@"%@%d",@"Response status code = ",[resp.StatusCode intValue]);
    NSLog(@"%@",[json Emit]);
    NSLog(@"%@",@"Failed");

    return;
}

// Show the successful JSON response.
NSLog(@"%@",[json Emit]);
NSLog(@"%@",@"Success.");

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