(Ruby) SharePoint -- Get Files in Root Folder

See more SharePoint Examples

Gets the list of files that exist in the root folder.

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.

# -------------------------------------------------------------------------
# The following comments apply to SharePoint Windows classic authentication.
# -------------------------------------------------------------------------
# For example, imagine our SharePoint endpoint is https://xyzoffice.mycompany.com/
# The SHAREPOINT_NTLM_DOMAIN would be "mycompany.com"
# The SHAREPOINT_HTTPS_DOMAIN would be "xyzoffice.mycompany.com"
# Also, the SHAREPOINT_USERNAME would be just the name, not a full email address.
# for example, "chilkat" instead of "chilkat@mycompany.com"

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

# Indicate that we want a JSON reply
http.put_Accept("application/json;odata=verbose")
http.put_AcceptCharset("utf-8")

# If your Sharepoint site is within a site collection, then use "https://SHAREPOINT_HTTPS_DOMAIN/sites/teamA/_api/web/GetFolderByServerRelativeUrl('/sites/teamA/')/Files" where "teamA" is the name of the site.
sbJson = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://SHAREPOINT_HTTPS_DOMAIN/_api/web/GetFolderByServerRelativeUrl('/')/Files",sbJson)
if (success != true)
    print http.lastErrorText() + "\n";
    exit
end

json = Chilkat::CkJsonObject.new()
json.LoadSb(sbJson)

# Iterate over the results and get each file's name, size, and last-modified date/time.

numFiles = json.SizeOfArray("d.results")
print "Number of Files in the SharePoint root folder = " + numFiles.to_s() + "\n";

lastMod = Chilkat::CkDateTime.new()

bLocal = true

i = 0
while i < numFiles
    json.put_I(i)

    filename = json.stringOf("d.results[i].Name")
    fileRelativeUri = json.stringOf("d.results[i].ServerRelativeUrl")
    fileSize = json.IntOf("d.results[i].Length")
    sLastModified = json.stringOf("d.results[i].TimeLastModified")

    print (i + 1).to_s() + ": " + filename + "\n";
    print "    Relative URI: " + fileRelativeUri + "\n";
    print "    Size in Bytes: " + fileSize.to_s() + "\n";

    # Show the last-modified date/time in the local timezone.
    lastMod.SetFromTimestamp(sLastModified)
    # dt is a CkDtObj
    dt = lastMod.GetDtObj(bLocal)
    print "    Last-Modified: " + dt.get_Day().to_s() + "/" + dt.get_Month().to_s() + "/" + dt.get_Year().to_s() + 
        " " + dt.get_Hour().to_s() + ":" + dt.get_Minute().to_s() + "\n";

    i = i + 1
end

# The output of this program when I tested it:

# 	Number of Files in the SharePoint root folder = 5
# 	1: Documentstester1.txt
# 	    Relative URI: /Documentstester1.txt
# 	    Size in Bytes: 17
# 	    Last-Modified: 6/4/2017 11:31
# 	2: Documents11_D42_Device_70_IP.xlsx
# 	    Relative URI: /Documents11_D42_Device_70_IP.xlsx
# 	    Size in Bytes: 17472
# 	    Last-Modified: 6/4/2017 10:54
# 	3: default.aspx
# 	    Relative URI: /default.aspx
# 	    Size in Bytes: 3960
# 	    Last-Modified: 26/10/2015 20:47
# 	4: DocumentsVCAC NEW Admin and RA bacgrounds.pptx
# 	    Relative URI: /DocumentsVCAC NEW Admin and RA bacgrounds.pptx
# 	    Size in Bytes: 11867024
# 	    Last-Modified: 6/4/2017 10:51
# 	5: DocumentsVCAC_Installer_Web_Sites_Installation.docx
# 	    Relative URI: /DocumentsVCAC_Installer_Web_Sites_Installation.docx
# 	    Size in Bytes: 529482
# 	    Last-Modified: 6/4/2017 11:0