(Ruby) SharePoint -- Rename File (or Move a File)

Demonstrates how to rename (or move) a SharePoint file.

See FileMoveTo for more details.

Chilkat Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

#  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 both move and rename /Documents/starfish.jpg to /Documents/ChilkatTest/starfish2.jpg

req = Chilkat::CkHttpRequest.new()
req.put_HttpVerb("POST")
req.put_Path("/_api/web/GetFileByServerRelativeUrl('/Documents/starfish.jpg')/MoveTo(newurl='/Documents/ChilkatTest/starfish2.jpg',flags=1)")

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

#  Send the HTTPS POST.
bUseTls = true
# resp is a CkHttpResponse
resp = http.SynchronousRequest("SHAREPOINT_HTTPS_DOMAIN",443,bUseTls,req)
if (http.get_LastMethodSuccess() != true)
    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";
    print "Failed" + "\n";

    exit
end

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