(Tcl) SharePoint -- Recycle File (Move File to Recycle Bin)

Moves the file to the Recycle Bin and returns the identifier of the new Recycle Bin item.

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

# 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

set req [new_CkHttpRequest]

CkHttpRequest_put_HttpVerb $req "POST"
CkHttpRequest_put_Path $req "/_api/web/GetFileByServerRelativeUrl('/ChilkatDocLibrary/sample.docx')/recycle"

# We must 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"

# Send the request to move the file to the recycle bin.
set bUseTls 1
# resp is a CkHttpResponse
set resp [CkHttp_SynchronousRequest $http "SHAREPOINT_HTTPS_DOMAIN" 443 $bUseTls $req]
if {[CkHttp_get_LastMethodSuccess $http] != 1} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkHttpRequest $req
    exit
}

set xml [new_CkXml]

CkXml_LoadXml $xml [CkHttpResponse_bodyStr $resp]

# A successful response will return the 200 status code.
if {[CkHttpResponse_get_StatusCode $resp] != 200} then {
    puts "Response status code = [CkHttpResponse_get_StatusCode $resp]"
    puts [CkXml_getXml $xml]
    puts "Failed"
    delete_CkHttpResponse $resp

    delete_CkHttp $http
    delete_CkHttpRequest $req
    delete_CkXml $xml
    exit
}

delete_CkHttpResponse $resp

# Show the XML response.
puts [CkXml_getXml $xml]

# The GUID (identifier) of the item in the recycle bin is just the content
# of the single-node XML that is returned:
set guid [CkXml_content $xml]
puts "GUID of recycle item = $guid"

puts "Success."

# A successful XML response looks like this:

# <?xml version="1.0" encoding="utf-8" ?>
# <d:Recycle xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices"
#  xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata"
#  xmlns:georss="http://www.georss.org/georss"
#  xmlns:gml="http://www.opengis.net/gml"
#  m:type="Edm.Guid">
#     63b9924d-e9c1-4d7b-b1c2-e921ad85aa1c
# </d:Recycle>

delete_CkHttp $http
delete_CkHttpRequest $req
delete_CkXml $xml