DataFlex
DataFlex
Retrieve a Particular SharePoint List as XML
See more SharePoint Examples
Downloads a particular SharePoint list and parses the XML.Chilkat DataFlex Downloads
Use ChilkatAx-win32.pkg
Procedure Test
Boolean iSuccess
Handle hoHttp
Variant vSbXml
Handle hoSbXml
Handle hoXml
Handle hoSbBase
Integer iNumEntries
Handle hoSbUri
Integer i
String sTitle
String sTemp1
Move False To iSuccess
// 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"
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
// If SharePoint Windows classic authentication is used, then set the
// Login, Password, LoginDomain, and NtlmAuth properties.
Set ComLogin Of hoHttp To "SHAREPOINT_USERNAME"
Set ComPassword Of hoHttp To "SHAREPOINT_PASSWORD"
Set ComLoginDomain Of hoHttp To "SHAREPOINT_NTLM_DOMAIN"
Set ComNtlmAuth Of hoHttp To True
// -------------------------------------------------------------------------
// 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
Set ComAccept Of hoHttp To "application/atom+xml"
Set ComAcceptCharset Of hoHttp To "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)
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbXml
If (Not(IsComObjectCreated(hoSbXml))) Begin
Send CreateComObject of hoSbXml
End
Get pvComObject of hoSbXml to vSbXml
Get ComQuickGetSb Of hoHttp "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/Lists(guid'SHAREPOINT_DOCUMENTS_GUID')/items" vSbXml To iSuccess
If (iSuccess <> True) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatXml)) To hoXml
If (Not(IsComObjectCreated(hoXml))) Begin
Send CreateComObject of hoXml
End
Get pvComObject of hoSbXml to vSbXml
Get ComLoadSb Of hoXml vSbXml True To iSuccess
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbBase
If (Not(IsComObjectCreated(hoSbBase))) Begin
Send CreateComObject of hoSbBase
End
Get ComGetAttrValue Of hoXml "xml:base" To sTemp1
Get ComAppend Of hoSbBase sTemp1 To iSuccess
Get ComGetAsString Of hoSbBase To sTemp1
Showln "Base URL = " sTemp1
// Find the number of entries in this list.
Get ComNumChildrenHavingTag Of hoXml "entry" To iNumEntries
Showln "Number of Entries in this SharePoint List = " iNumEntries
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbUri
If (Not(IsComObjectCreated(hoSbUri))) Begin
Send CreateComObject of hoSbUri
End
Move 0 To i
While (i < iNumEntries)
Set ComI Of hoXml To i
Get ComGetChildContent Of hoXml "entry[i]|content|m:properties|d:Title" To sTitle
Get ComGetAsString Of hoSbBase To sTemp1
Get ComSetString Of hoSbUri sTemp1 To iSuccess
Get ComGetChildContent Of hoXml "entry[i]|id" To sTemp1
Get ComAppend Of hoSbUri sTemp1 To iSuccess
Showln (i + 1) ": " sTitle
Get ComGetAsString Of hoSbUri To sTemp1
Showln "URI: " sTemp1
Move (i + 1) To i
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)
//
//
End_Procedure