Ruby

SharePoint -- Delete a File

Demonstrates how to delete a SharePoint file. Ruby

require 'chilkat'

success = false

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

http = Chilkat::CkHttp.new()

# If SharePoint Windows classic authentication is used, then set the 
# Login, Password, LoginDomain, and NtlmAuth properties.
http.put_Login("SHAREPOINT_USERNAME")
http.put_Password("SHAREPOINT_PASSWORD")
http.put_LoginDomain("SHAREPOINT_NTLM_DOMAIN")
http.put_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

# This example will delete the file named "penguins2.jpg" 
# which is located in the "/Documents" folder.

req = Chilkat::CkHttpRequest.new()
req.put_HttpVerb("POST")
req.put_Path("/_api/web/GetFileByServerRelativeUrl('/Documents/penguins2.jpg')")

# 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")

# Add additional required headers.
req.AddHeader("IF-MATCH","*")
req.AddHeader("X-HTTP-Method","DELETE")

# Send the POST using https (TLS). Port 443 is the default port for https.
bUseTls = true
resp = Chilkat::CkHttpResponse.new()
success = http.HttpSReq("SHAREPOINT_HTTPS_DOMAIN",443,bUseTls,req,resp)
if (success == false)
    print http.lastErrorText() + "\n";
    exit
end

# If failed, the response body contains XML 
xml = Chilkat::CkXml.new()
xml.LoadXml(resp.bodyStr())

if (resp.get_StatusCode() != 200)
    print "Response status code = " + resp.get_StatusCode().to_s() + "\n";
    print xml.getXml() + "\n";

    # For example, if the file did not exist, this would be the XML response:
    # <?xml version="1.0" encoding="utf-8" ?>
    # <m:error xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata">
    #     <m:code>-2146232832, Microsoft.SharePoint.SPException</m:code>
    #     <m:message xml:lang="en-US">The file /Documents/penguins2.jpg does not exist.</m:message>
    # </m:error>
    # 

    print "Failed" + "\n";
    exit
end

# If successful, the response body is empty.
print "Success." + "\n";