Tcl

SharePoint -- Get File Metadata (File Size, Last-Modified Date/Time, etc.)

See more SharePoint Examples

Demonstrates how to get a file's metdata, which includes the file size, last-modified date/time, name, server relative URL, etc. Tcl

load ./chilkat.dll

set success 0

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

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"

set url "https://SHAREPOINT_HTTPS_DOMAIN/_api/web/GetFileByServerRelativeUrl('/Documents/VCAC-document.docx')"

set jsonReply [CkHttp_quickGetStr $http $url]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    exit
}

# Examine the file's metadata in JSON format.
set json [new_CkJsonObject]

CkJsonObject_Load $json $jsonReply
CkJsonObject_put_EmitCompact $json 0

# Make sure it was a success response, and that we really have metadata.
# If it was an error response, then the JSON is error information..
if {[CkHttp_get_LastStatus $http] != 200} then {
    puts [CkJsonObject_emit $json]
    puts "Failed."
    delete_CkHttp $http
    delete_CkJsonObject $json
    exit
}

puts [CkJsonObject_emit $json]

puts "--------"
puts "Server relative URL: [CkJsonObject_stringOf $json d.ServerRelativeUrl]"

set fileSize [CkJsonObject_IntOf $json "d.Length"]
puts "File Size = $fileSize"

set lastmod [new_CkDateTime]

CkDateTime_SetFromTimestamp $lastmod [CkJsonObject_stringOf $json "d.TimeLastModified"]

# Once we have the CkDateTime object, we can get the date/time in all sorts of formats:

# Get as a RFC822 GMT string:
set bLocalTime 0
puts [CkDateTime_getAsRfc822 $lastmod $bLocalTime]

# Get as an RFC822 string in the local timezone.
# (remember, the daylight savings that existed at the given time in the past is applied)
set bLocalTime 1
puts [CkDateTime_getAsRfc822 $lastmod $bLocalTime]

# Get as a 32-bit UNIX time (local or GMT..)
# The Unix time is number of seconds since the Epoch, 1970-01-01 00:00:00 +0000 (UTC). 
set unixTime [CkDateTime_GetAsUnixTime $lastmod $bLocalTime]
puts "Unix time: $unixTime"

# One can also get the as a "DtObj" object for accessing the individual
# parts of the date/time, such as month, day, year, hour, minute, etc.
# The DtObj can be obtained in the GMT or local timezone:
set dtObj [new_CkDtObj]

CkDateTime_ToDtObj $lastmod $bLocalTime $dtObj

if {[CkDateTime_get_LastMethodSuccess $lastmod] == 0} then {
    puts "This should never really happen!"
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkDateTime $lastmod
    delete_CkDtObj $dtObj
    exit
}

puts [CkDtObj_get_Day $dtObj]-[CkDtObj_get_Month $dtObj]-[CkDtObj_get_Year $dtObj] [CkDtObj_get_Hour $dtObj]:[CkDtObj_get_Minute $dtObj]:[CkDtObj_get_Second $dtObj]

# -------------------------------------------------
# The file's metadata look like this:

# { 
#   "d": { 
#     "__metadata": { 
#       "id": "Web/GetFileByServerRelativeUrl('/Documents/VCAC-document.docx')",
#       "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFileByServerRelativeUrl('/Documents/VCAC-document.docx')",
#       "type": "SP.File"
#     },
#     "Author": { 
#       "__deferred": { 
#         "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFileByServerRelativeUrl('/Documents/VCAC-document.docx')/Author"
#       }
#     },
#     "CheckedOutByUser": { 
#       "__deferred": { 
#         "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFileByServerRelativeUrl('/Documents/VCAC-document.docx')/CheckedOutByUser"
#       }
#     },
#     "ListItemAllFields": { 
#       "__deferred": { 
#         "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFileByServerRelativeUrl('/Documents/VCAC-document.docx')/ListItemAllFields"
#       }
#     },
#     "LockedByUser": { 
#       "__deferred": { 
#         "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFileByServerRelativeUrl('/Documents/VCAC-document.docx')/LockedByUser"
#       }
#     },
#     "ModifiedBy": { 
#       "__deferred": { 
#         "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFileByServerRelativeUrl('/Documents/VCAC-document.docx')/ModifiedBy"
#       }
#     },
#     "Versions": { 
#       "__deferred": { 
#         "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFileByServerRelativeUrl('/Documents/VCAC-document.docx')/Versions"
#       }
#     },
#     "CheckInComment": "",
#     "CheckOutType": 2,
#     "ContentTag": "{E2F05E75-B3EF-4826-8284-E572D3628A7D},9,10",
#     "CustomizedPageStatus": 0,
#     "ETag": "\"{E2F05E75-B3EF-4826-8284-E572D3628A7D},9\"",
#     "Exists": true,
#     "Length": "21082",
#     "Level": 2,
#     "MajorVersion": 0,
#     "MinorVersion": 3,
#     "Name": "VCAC-document.docx",
#     "ServerRelativeUrl": "/Documents/VCAC-document.docx",
#     "TimeCreated": "2016-03-04T12:38:01Z",
#     "TimeLastModified": "2017-01-16T04:44:31Z",
#     "Title": "",
#     "UIVersion": 3,
#     "UIVersionLabel": "0.3"
#   }
# }
# 

delete_CkHttp $http
delete_CkJsonObject $json
delete_CkDateTime $lastmod
delete_CkDtObj $dtObj