(PowerBuilder) 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

integer li_rc
oleobject loo_Http
string ls_Url
string ls_JsonReply
oleobject loo_Json
integer li_FileSize
oleobject loo_Lastmod
integer li_BLocalTime
integer li_UnixTime
oleobject loo_DtObj

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

loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

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

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

ls_JsonReply = loo_Http.QuickGetStr(ls_Url)
if loo_Http.LastMethodSuccess <> 1 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    return
end if

// Examine the file's metadata in JSON format.
loo_Json = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")

loo_Json.Load(ls_JsonReply)
loo_Json.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 loo_Http.LastStatus <> 200 then
    Write-Debug loo_Json.Emit()
    Write-Debug "Failed."
    destroy loo_Http
    destroy loo_Json
    return
end if

Write-Debug loo_Json.Emit()

Write-Debug "--------"
Write-Debug "Server relative URL: " + loo_Json.StringOf("d.ServerRelativeUrl")

li_FileSize = loo_Json.IntOf("d.Length")
Write-Debug "File Size = " + string(li_FileSize)

loo_Lastmod = create oleobject
// Use "Chilkat_9_5_0.CkDateTime" for versions of Chilkat < 10.0.0
li_rc = loo_Lastmod.ConnectToNewObject("Chilkat.CkDateTime")

loo_Lastmod.SetFromTimestamp(loo_Json.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:
li_BLocalTime = 0
Write-Debug loo_Lastmod.GetAsRfc822(li_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)
li_BLocalTime = 1
Write-Debug loo_Lastmod.GetAsRfc822(li_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). 
li_UnixTime = loo_Lastmod.GetAsUnixTime(li_BLocalTime)
Write-Debug "Unix time: " + string(li_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:
loo_DtObj = loo_Lastmod.GetDtObj(li_BLocalTime)
if loo_Lastmod.LastMethodSuccess = 0 then
    Write-Debug "This should never really happen!"
    destroy loo_Http
    destroy loo_Json
    destroy loo_Lastmod
    return
end if

Write-Debug string(loo_DtObj.Day) + "-" + string(loo_DtObj.Month) + "-" + string(loo_DtObj.Year) + " " + string(loo_DtObj.Hour) + ":" + string(loo_DtObj.Minute) + ":" + string(loo_DtObj.Second)

destroy loo_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"
//   }
// }
// 


destroy loo_Http
destroy loo_Json
destroy loo_Lastmod