PowerBuilder

SharePoint -- Get File Property

Demonstrates how to get a specific property of a SharePoint file. Any of the following properties can be retrieved:

Author: Gets a value that specifies the user who added the file.
CheckedOutByUser: Gets a value that returns the user who has checked out the file.
CheckInComment: Gets a value that returns the comment used when a document is checked in to a document library.
CheckOutType: Gets a value that indicates how the file is checked out of a document library. Represents an
ContentTag: Returns internal version of content, used to validate document equality for read purposes.
CustomizedPageStatus: Gets a value that specifies the customization status of the file. Represents an
ETag: Gets a value that specifies the ETag value.
Exists: Gets a value that specifies whether the file exists.
Length: Gets the size of the file in bytes, excluding the size of any Web Parts that are used in the file.
Level: Gets a value that specifies the publishing level of the file. Represents an
ListItemAllFields: Gets a value that specifies the list item field values for the list item corresponding to the file.
LockedByUser: Gets a value that returns the user that owns the current lock on the file.
MajorVersion: Gets a value that specifies the major version of the file.
MinorVersion: Gets a value that specifies the minor version of the file.
ModifiedBy: Gets a value that returns the user who last modified the file.
Name: Gets the name of the file including the extension.
ServerRelativeUrl: Gets the relative URL of the file based on the URL for the server.
TimeCreated: Gets a value that specifies when the file was created.
TimeLastModified: Gets a value that specifies when the file was last modified.
Title: Gets a value that specifies the display name of the file.
UiVersion: Gets a value that specifies the implementation-specific version identifier of the file.
UiVersionLabel: Gets a value that specifies the implementation-specific version identifier of the file.
Versions: Gets a value that returns a collection of file version objects that represent the versions of the file.

Chilkat PowerBuilder Downloads

PowerBuilder

integer li_rc
integer li_Success
oleobject loo_Http
string ls_Url
string ls_JsonReply
oleobject loo_Json
integer li_NumVersions
integer i

li_Success = 0

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

loo_Http = create oleobject
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"

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

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

loo_Json = create oleobject
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()

// The Author property returns JSON looking like this:

// {
//   "d": {
//     "__metadata": {
//       "id": "Web/GetUserById(18)",
//       "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetUserById(18)",
//       "type": "SP.User"
//     },
//     "Groups": {
//       "__deferred": {
//         "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetUserById(18)/Groups"
//       }
//     },
//     "Id": 18,
//     "IsHiddenInUI": false,
//     "LoginName": "i:0#.w|mydomain\\msmith",
//     "Title": "Mike Smith",
//     "PrincipalType": 1,
//     "Email": "msmith@mydomain.com",
//     "IsSiteAdmin": false,
//     "UserId": {
//       "__metadata": {
//         "type": "SP.UserIdInfo"
//       },
//       "NameId": "s-1-5-21-3433503314-2897774614-343593928-1137",
//       "NameIdIssuer": "urn:office:idp:activedirectory"
//     }
//   }
// }
// 

// Get the Title and Email:
Write-Debug "----"
Write-Debug "Title: " + loo_Json.StringOf("d.Title")
Write-Debug "Email: " + loo_Json.StringOf("d.Email")
Write-Debug "----"

// --------------------------------------------------------------------

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

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

loo_Json.Load(ls_JsonReply)
Write-Debug loo_Json.Emit()

// The Versions JSON reply looks like this:

// {
//   "d": {
//     "results": [
//       {
//         "__metadata": {
//           "id": "a8d025e2-8255-4487-9edb-9e796ab2889c",
//           "type": "SP.FileVersion"
//         },
//         "CreatedBy": {
//           "__deferred": {
//             "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/CreatedBy"
//           }
//         },
//         "CheckInComment": "",
//         "Created": "2016-03-15T02:22:26Z",
//         "ID": 1,
//         "IsCurrentVersion": false,
//         "Size": 21082,
//         "Url": "_vti_history/1/Documents/VCAC-document.docx",
//         "VersionLabel": "0.1"
//       },
//       {
//         "__metadata": {
//           "id": "8ab3eadd-9126-4f65-a2a3-3b0689c592d6",
//           "type": "SP.FileVersion"
//         },
//         "CreatedBy": {
//           "__deferred": {
//             "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/CreatedBy"
//           }
//         },
//         "CheckInComment": "",
//         "Created": "2016-03-15T05:28:24Z",
//         "ID": 2,
//         "IsCurrentVersion": false,
//         "Size": 21082,
//         "Url": "_vti_history/2/Documents/VCAC-document.docx",
//         "VersionLabel": "0.2"
//       }
//     ]
//   }
// }
// 

// Get each VersionLabel, Size, and Url...
li_NumVersions = loo_Json.SizeOfArray("d.results")
i = 0
do while i < li_NumVersions
    loo_Json.I = i
    Write-Debug "---- i = " + string(i)
    Write-Debug "VersionLabel: " + loo_Json.StringOf("d.results[i].VersionLabel")
    Write-Debug "Url: " + loo_Json.StringOf("d.results[i].Url")
    Write-Debug "Size: " + string(loo_Json.IntOf("d.results[i].Size"))
    i = i + 1
loop

// The output is:

// ---- i = 0
// VersionLabel: 0.1
// Url: _vti_history/1/Documents/VCAC-document.docx
// Size: 21082
// ---- i = 1
// VersionLabel: 0.2
// Url: _vti_history/2/Documents/VCAC-document.docx
// Size: 21082


destroy loo_Http
destroy loo_Json