(Visual FoxPro) 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.

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

LOCAL loHttp
LOCAL lcUrl
LOCAL lcJsonReply
LOCAL loJson
LOCAL lnFileSize
LOCAL loLastmod
LOCAL lnBLocalTime
LOCAL lnUnixTime
LOCAL loDtObj

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* If SharePoint Windows classic authentication is used, then set the 
* Login, Password, LoginDomain, and NtlmAuth properties.
loHttp.Login = "SHAREPOINT_USERNAME"
loHttp.Password = "SHAREPOINT_PASSWORD"
loHttp.LoginDomain = "SHAREPOINT_NTLM_DOMAIN"
loHttp.NtlmAuth = 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
loHttp.Accept = "application/json;odata=verbose"
loHttp.AcceptCharset = "utf-8"

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

lcJsonReply = loHttp.QuickGetStr(lcUrl)
IF (loHttp.LastMethodSuccess <> 1) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    CANCEL
ENDIF

* Examine the file's metadata in JSON format.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.Load(lcJsonReply)
loJson.EmitCompact = 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 (loHttp.LastStatus <> 200) THEN
    ? loJson.Emit()
    ? "Failed."
    RELEASE loHttp
    RELEASE loJson
    CANCEL
ENDIF

? loJson.Emit()

? "--------"
? "Server relative URL: " + loJson.StringOf("d.ServerRelativeUrl")

lnFileSize = loJson.IntOf("d.Length")
? "File Size = " + STR(lnFileSize)

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.CkDateTime')
loLastmod = CreateObject('Chilkat.CkDateTime')
loLastmod.SetFromTimestamp(loJson.StringOf("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:
lnBLocalTime = 0
? loLastmod.GetAsRfc822(lnBLocalTime)

* Get as an RFC822 string in the local timezone.
* (remember, the daylight savings that existed at the given time in the past is applied)
lnBLocalTime = 1
? loLastmod.GetAsRfc822(lnBLocalTime)

* 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). 
lnUnixTime = loLastmod.GetAsUnixTime(lnBLocalTime)
? "Unix time: " + STR(lnUnixTime)

* 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:
loDtObj = loLastmod.GetDtObj(lnBLocalTime)
IF (loLastmod.LastMethodSuccess = 0) THEN
    ? "This should never really happen!"
    RELEASE loHttp
    RELEASE loJson
    RELEASE loLastmod
    CANCEL
ENDIF

? STR(loDtObj.Day) + "-" + STR(loDtObj.Month) + "-" + STR(loDtObj.Year) + " " + STR(loDtObj.Hour) + ":" + STR(loDtObj.Minute) + ":" + STR(loDtObj.Second)

RELEASE loDtObj

* -------------------------------------------------
* 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"
*   }
* }
* 

RELEASE loHttp
RELEASE loJson
RELEASE loLastmod