Tcl

SharePoint -- Create Folder

See more SharePoint Examples

This example shows how to create a new SharePoint folder. Tcl

load ./chilkat.dll

set success 0

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

set http [new_CkHttp]

# If SharePoint Windows classic authentication is used, then set the 
# Login, Password, LoginDomain, and NtlmAuth properties.
CkHttp_put_Login $http "SHAREPOINT_USERNAME"
CkHttp_put_Password $http "SHAREPOINT_PASSWORD"
CkHttp_put_LoginDomain $http "SHAREPOINT_NTLM_DOMAIN"
CkHttp_put_NtlmAuth $http 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 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

set req [new_CkHttpRequest]

CkHttpRequest_put_HttpVerb $req "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.
CkHttpRequest_put_Path $req "/_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
CkHttpRequest_AddHeader $req "X-RequestDigest" "SHAREPOINT_FORM_DIGEST"

# Set the Content-Type, and indicate that a JSON response is desired.
CkHttpRequest_put_ContentType $req "application/json;odata=verbose"
CkHttpRequest_AddHeader $req "Accept" "application/json;odata=verbose"

# Create and add the JSON body.
set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "__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.
CkJsonObject_UpdateString $json "ServerRelativeUrl" "/Documents/ChilkatTest"
CkHttpRequest_LoadBodyFromString $req [CkJsonObject_emit $json] "utf-8"

# Send the POST using HTTPS (TLS). Port 443 is the default port for https.
set bUseTls 1
set resp [new_CkHttpResponse]

set success [CkHttp_HttpSReq $http "SHAREPOINT_HTTPS_DOMAIN" 443 $bUseTls $req $resp]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkHttpRequest $req
    delete_CkJsonObject $json
    delete_CkHttpResponse $resp
    exit
}

# The response body contains JSON.
CkJsonObject_Load $json [CkHttpResponse_bodyStr $resp]
CkJsonObject_put_EmitCompact $json 0

# The expected success response code is 201.
# (Let's also check for 200, just in case things change..)
if {expr [[CkHttpResponse_get_StatusCode $resp] != 200]  &&  [[CkHttpResponse_get_StatusCode $resp] != 201]} then {
    puts "Response status code = [CkHttpResponse_get_StatusCode $resp]"
    puts [CkJsonObject_emit $json]
    puts "Failed"
    delete_CkHttp $http
    delete_CkHttpRequest $req
    delete_CkJsonObject $json
    delete_CkHttpResponse $resp
    exit
}

# Show the successful JSON response.
puts [CkJsonObject_emit $json]
puts "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": ""
#   }
# }

delete_CkHttp $http
delete_CkHttpRequest $req
delete_CkJsonObject $json
delete_CkHttpResponse $resp