(JavaScript) SharePoint -- Create Folder

See more SharePoint Examples

For more information, see https://docs.microsoft.com/en-us/sharepoint/dev/sp-add-ins/working-with-folders-and-files-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 folder, we're going to POST to
// https://SHAREPOINT_HTTPS_DOMAIN/_api/web/folders
// with a request body containing the following JSON:
// 
//     { "__metadata": { "type": "SP.Folder" }, "ServerRelativeUrl": "/document_library_relative_url/newFolderName"}

// This example will create a folder named ChilkatTest in /Documents

// Note: if your Sharepoint site is within a site collection, you must add the site name "/sites/teamA" to both the Path and the ServerRelativeUrl

var req = new CkHttpRequest();
req.HttpVerb = "POST";
// If your Sharepoint site is within a site collection, then use "/sites/teamA/_api/web/folders" where "teamA" is the name of the site.
req.Path = "/_api/web/folders";

// 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.
var json = new CkJsonObject();
json.UpdateString("__metadata.type","SP.Folder");
// If your Sharepoint site is within a site collection, then use "/sites/teamA/Documents/ChilkatTest" where "teamA" is the name of the site.
json.UpdateString("ServerRelativeUrl","/Documents/ChilkatTest");
req.LoadBodyFromString(json.Emit(),"utf-8");

// 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.");

// A successful JSON response looks like this:

// { 
//   "d": { 
//     "__metadata": { 
//       "id": "Web/GetFolderByServerRelativeUrl('/Documents/ChilkatTest')",
//       "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFolderByServerRelativeUrl('/Documents/ChilkatTest')",
//       "type": "SP.Folder"
//     },
//     "Files": { 
//       "__deferred": { 
//         "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFolderByServerRelativeUrl('/Documents/ChilkatTest')/Files"
//       }
//     },
//     "ListItemAllFields": { 
//       "__deferred": { 
//         "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFolderByServerRelativeUrl('/Documents/ChilkatTest')/ListItemAllFields"
//       }
//     },
//     "ParentFolder": { 
//       "__deferred": { 
//         "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFolderByServerRelativeUrl('/Documents/ChilkatTest')/ParentFolder"
//       }
//     },
//     "Properties": { 
//       "__deferred": { 
//         "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFolderByServerRelativeUrl('/Documents/ChilkatTest')/Properties"
//       }
//     },
//     "Folders": { 
//       "__deferred": { 
//         "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFolderByServerRelativeUrl('/Documents/ChilkatTest')/Folders"
//       }
//     },
//     "ItemCount": 0,
//     "Name": "ChilkatTest",
//     "ServerRelativeUrl": "/Documents/ChilkatTest",
//     "WelcomePage": ""
//   }
// }