(Ruby) SharePoint -- Get Files in Documents Folder

See more SharePoint Examples

Gets the list of files that exist in the /Documents 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/Documents')/Files" where "teamA" is the name of the site.
sbJson = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://SHAREPOINT_HTTPS_DOMAIN/_api/web/GetFolderByServerRelativeUrl('/Documents')/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 /Documents 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 /Documents folder = 13
# 	1: VCAC_DISA_brief_8_13_16.pdf
# 	    Relative URI: /Documents/VCAC_DISA_brief_8_13_16.pdf
# 	    Size in Bytes: 5571942
# 	    Last-Modified: 14/8/2016 21:32
# 	2: Test Procedure Self-Registration Kiosk.docx
# 	    Relative URI: /Documents/Test Procedure Self-Registration Kiosk.docx
# 	    Size in Bytes: 26568
# 	    Last-Modified: 16/1/2017 10:46
# 	3: VCAC_Architecture_Brief_8_29_15.pptx
# 	    Relative URI: /Documents/VCAC_Architecture_Brief_8_29_15.pptx
# 	    Size in Bytes: 28756136
# 	    Last-Modified: 17/3/2016 15:32
# 	4: D42_Device_70_IP.xlsx
# 	    Relative URI: /Documents/D42_Device_70_IP.xlsx
# 	    Size in Bytes: 17060
# 	    Last-Modified: 14/3/2016 21:22
# 	5: Domain Name created for Exchange.docx
# 	    Relative URI: /Documents/Domain Name created for Exchange.docx
# 	    Size in Bytes: 80651
# 	    Last-Modified: 16/1/2017 11:8
# 	6: VCAC_Architecture_Brief_8_29_15.pdf
# 	    Relative URI: /Documents/VCAC_Architecture_Brief_8_29_15.pdf
# 	    Size in Bytes: 5814495
# 	    Last-Modified: 17/3/2016 15:30
# 	7: D42_Device_70_IP223.xlsx
# 	    Relative URI: /Documents/D42_Device_70_IP223.xlsx
# 	    Size in Bytes: 17109
# 	    Last-Modified: 16/1/2017 12:1
# 	8: image_VCAC.png
# 	    Relative URI: /Documents/image_VCAC.png
# 	    Size in Bytes: 4825795
# 	    Last-Modified: 21/3/2016 14:13
# 	9: FRC_Summit_brief.pdf
# 	    Relative URI: /Documents/FRC_Summit_brief.pdf
# 	    Size in Bytes: 2202216
# 	    Last-Modified: 14/8/2016 21:31
# 	10: VCAC_RA_Design.docx
# 	    Relative URI: /Documents/VCAC_RA_Design.docx
# 	    Size in Bytes: 32278
# 	    Last-Modified: 15/1/2017 22:44
# 	11: VCAC_PEO_EIS_Brief_3_23_16.pdf
# 	    Relative URI: /Documents/VCAC_PEO_EIS_Brief_3_23_16.pdf
# 	    Size in Bytes: 7239114
# 	    Last-Modified: 22/3/2016 17:50
# 	12: VCAC-document.docx
# 	    Relative URI: /Documents/VCAC-document.docx
# 	    Size in Bytes: 21082
# 	    Last-Modified: 15/1/2017 22:44
# 	13: Engineering_Drawing (sample).jpg
# 	    Relative URI: /Documents/Engineering_Drawing (sample).jpg
# 	    Size in Bytes: 97638
# 	    Last-Modified: 22/3/2016 17:51