(Tcl) SharePoint -- Get Files in Documents Folder

See more SharePoint Examples

Gets the list of files that exist in the /Documents folder.

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.

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

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

# Indicate that we want a JSON reply
CkHttp_put_Accept $http "application/json;odata=verbose"
CkHttp_put_AcceptCharset $http "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.
set sbJson [new_CkStringBuilder]

set success [CkHttp_QuickGetSb $http "https://SHAREPOINT_HTTPS_DOMAIN/_api/web/GetFolderByServerRelativeUrl('/Documents')/Files" $sbJson]
if {$success != 1} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkStringBuilder $sbJson
    exit
}

set json [new_CkJsonObject]

CkJsonObject_LoadSb $json $sbJson

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

set numFiles [CkJsonObject_SizeOfArray $json "d.results"]
puts "Number of Files in the SharePoint /Documents folder = $numFiles"

set lastMod [new_CkDateTime]

# dt is a CkDtObj

set bLocal 1

set i 0
while {$i < $numFiles} {
    CkJsonObject_put_I $json $i

    set filename [CkJsonObject_stringOf $json "d.results[i].Name"]
    set fileRelativeUri [CkJsonObject_stringOf $json "d.results[i].ServerRelativeUrl"]
    set fileSize [CkJsonObject_IntOf $json "d.results[i].Length"]
    set sLastModified [CkJsonObject_stringOf $json "d.results[i].TimeLastModified"]

    puts [expr $i + 1]: $filename
    puts "    Relative URI: $fileRelativeUri"
    puts "    Size in Bytes: $fileSize"

    # Show the last-modified date/time in the local timezone.
    CkDateTime_SetFromTimestamp $lastMod $sLastModified
    set dt [CkDateTime_GetDtObj $lastMod $bLocal]
    puts "    Last-Modified: [CkDtObj_get_Day $dt]/[CkDtObj_get_Month $dt]/[CkDtObj_get_Year $dt] [CkDtObj_get_Hour $dt]:[CkDtObj_get_Minute $dt]"
    delete_CkDtObj $dt

    set i [expr $i + 1]
}

# 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

delete_CkHttp $http
delete_CkStringBuilder $sbJson
delete_CkJsonObject $json
delete_CkDateTime $lastMod