PowerBuilder

Retrieve a Particular SharePoint List as XML

See more SharePoint Examples

Downloads a particular SharePoint list and parses the XML. PowerBuilder

integer li_rc
long li_Success
oleobject loo_Http
oleobject loo_SbXml
oleobject loo_Xml
oleobject loo_SbBase
long li_NumEntries
oleobject loo_SbUri
long i
string ls_Title

li_Success = 0

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

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 an XML reply
loo_Http.Accept = "application/atom+xml"
loo_Http.AcceptCharset = "utf-8"

//  The contents of a SharePoint list can be downloaded by it's URI,
//  which has the following URL format:
//  https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/items
//  
//  To get the URI's for all SharePoint lists, 
//  See Get SharePoint Lists.

//  Download the list like this (where the SHAREPOINT_DOCUMENTS_GUID is replaced with the actual GUID)
loo_SbXml = create oleobject
li_rc = loo_SbXml.ConnectToNewObject("Chilkat.StringBuilder")

li_Success = loo_Http.QuickGetSb("https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/Lists(guid'SHAREPOINT_DOCUMENTS_GUID')/items",loo_SbXml)
if li_Success <> 1 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_SbXml
    return
end if

loo_Xml = create oleobject
li_rc = loo_Xml.ConnectToNewObject("Chilkat.Xml")

loo_Xml.LoadSb(loo_SbXml,1)

loo_SbBase = create oleobject
li_rc = loo_SbBase.ConnectToNewObject("Chilkat.StringBuilder")

loo_SbBase.Append(loo_Xml.GetAttrValue("xml:base"))
Write-Debug "Base URL = " + loo_SbBase.GetAsString()

//  Find the number of entries in this list.
li_NumEntries = loo_Xml.NumChildrenHavingTag("entry")
Write-Debug "Number of Entries in this SharePoint List = " + string(li_NumEntries)

loo_SbUri = create oleobject
li_rc = loo_SbUri.ConnectToNewObject("Chilkat.StringBuilder")

i = 0
do while i < li_NumEntries
    loo_Xml.I = i

    ls_Title = loo_Xml.GetChildContent("entry[i]|content|m:properties|d:Title")

    loo_SbUri.SetString(loo_SbBase.GetAsString())
    loo_SbUri.Append(loo_Xml.GetChildContent("entry[i]|id"))

    Write-Debug string(i + 1) + ": " + ls_Title
    Write-Debug "URI: " + loo_SbUri.GetAsString()

    i = i + 1
loop

//  The output of this program (when I ran w/ my test SharePoint data) looks something like this:

//  I found that not every item has a Title,  but as viewed in a browser, I can see each of the item's name.
//  (The number of items agrees with what I can interactively see in a browser.) The mystery of what
//  is being shown for the name (or title) in the browser will be investigated further as Chilkat
//  continues to explore the SharePoint API...

//  	Base URL = https://xyzoffice.mycompany.com/_api/
//  	Number of Entries in this SharePoint List = 13
//  	1: Domain Name created for Exchange Docx
//  	URI: https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/Items(3)
//  	2: 
//  	URI: https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/Items(4)
//  	3: VCAC_RA_Design.docx
//  	URI: https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/Items(5)
//  	4: 
//  	URI: https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/Items(9)
//  	5: 
//  	URI: https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/Items(10)
//  	6: Architecture Briefv1
//  	URI: https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/Items(16)
//  	7: PowerPoint Presentation
//  	URI: https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/Items(17)
//  	8: 
//  	URI: https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/Items(18)
//  	9: 
//  	URI: https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/Items(19)
//  	10: 
//  	URI: https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/Items(20)
//  	11: FRC Summit Brief
//  	URI: https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/Items(21)
//  	12: VCAC DISA Brief 8-13-16
//  	URI: https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/Items(22)
//  	13: TEST PROCEDURE
//  	URI: https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/Items(23)
//  
//  


destroy loo_Http
destroy loo_SbXml
destroy loo_Xml
destroy loo_SbBase
destroy loo_SbUri