AutoIt
AutoIt
Retrieve a Particular SharePoint List as JSON
See more SharePoint Examples
Downloads a particular SharePoint list and parses the JSON.Chilkat AutoIt Downloads
Local $bSuccess = False
; 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"
$oHttp = ObjCreate("Chilkat.Http")
; If SharePoint Windows classic authentication is used, then set the
; Login, Password, LoginDomain, and NtlmAuth properties.
$oHttp.Login = "SHAREPOINT_USERNAME"
$oHttp.Password = "SHAREPOINT_PASSWORD"
$oHttp.LoginDomain = "SHAREPOINT_NTLM_DOMAIN"
$oHttp.NtlmAuth = 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 a JSON reply
$oHttp.Accept = "application/json;odata=verbose"
$oHttp.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)
$oSbJson = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/Lists(guid'SHAREPOINT_DOCUMENTS_GUID')/items",$oSbJson)
If ($bSuccess <> True) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.LoadSb($oSbJson)
$oJson.EmitCompact = False
; Iterate over the items in this list.
Local $iNumItems = $oJson.SizeOfArray("d.results")
ConsoleWrite("Number of Items in this SharePoint List = " & $iNumItems & @CRLF)
Local $i = 0
While $i < $iNumItems
$oJson.I = $i
Local $sTitle = $oJson.StringOf("d.results[i].Title")
Local $sUri = $oJson.StringOf("d.results[i].__metadata.uri")
ConsoleWrite(($i + 1) & ": " & $sTitle & @CRLF)
; This is the URI for the Nth item in this list
ConsoleWrite("URI: " & $sUri & @CRLF)
$i = $i + 1
Wend
; My output when testing is like what is shown below.
; 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...
; Number of Items 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: null
; 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: null
; URI: https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/Items(9)
; 5: null
; 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: null
; URI: https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/Items(18)
; 9: null
; URI: https://xyzoffice.mycompany.com/_api/Web/Lists(guid'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')/Items(19)
; 10: null
; 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)
;