(Visual FoxPro) SharePoint -- Upload File

See more SharePoint Examples

Demonstrates how to upload a file to a SharePoint folder.

For more information, see https://learn.microsoft.com/en-us/sharepoint/dev/sp-add-ins/working-with-folders-and-files-with-rest

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

LOCAL loHttp
LOCAL lcSavedAccept
LOCAL loResp
LOCAL loXml
LOCAL loReq
LOCAL lnBUseTls

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* If SharePoint Windows classic authentication is used, then set the 
* Login, Password, LoginDomain, and NtlmAuth properties.
loHttp.Login = "SHAREPOINT_USERNAME"
loHttp.Password = "SHAREPOINT_PASSWORD"
loHttp.LoginDomain = "SHAREPOINT_NTLM_DOMAIN"
loHttp.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
* -------------------------------------------------------------------------

* When creating, updating, and deleting SharePoint entities, we'll need
* to first get the server's form digest value to send in the X-RequestDigest header.
* This can be retrieved by making a POST request with an empty body to
* http://<site url>/_api/contextinfo and extracting the value of the
* d:FormDigestValue node in the XML that the contextinfo endpoint returns.

* Apparently, SharePoint needs an "Accept" request header equal to "application/xml",
* otherwise SharePoint will return an utterly incomprehensible and useless error message.
lcSavedAccept = loHttp.Accept
loHttp.Accept = "application/xml"

* If your Sharepoint site is within a site collection, then use "https://SHAREPOINT_HTTPS_DOMAIN/sites/teamA/_api/contextinfo" where "teamA" is the name of the site.
loResp = loHttp.PostXml("https://SHAREPOINT_HTTPS_DOMAIN/_api/contextinfo","","utf-8")
IF (loHttp.LastMethodSuccess <> 1) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    CANCEL
ENDIF

* Restore the default Accept header
loHttp.Accept = lcSavedAccept

IF (loResp.StatusCode <> 200) THEN
    * A response status code not equal to 200 indicates failure.
    ? "Response status code = " + STR(loResp.StatusCode)
    ? "Response body:"
    ? loResp.BodyStr
    RELEASE loResp
    RELEASE loHttp
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Xml')
loXml = CreateObject('Chilkat.Xml')
loXml.LoadXml(loResp.BodyStr)
RELEASE loResp

? loXml.GetXml()

* The response XML looks like this:

* <?xml version="1.0" encoding="utf-8" ?>
* <d:GetContextWebInformation xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns:georss="http://www.georss.org/georss" xmlns:gml="http://www.opengis.net/gml" m:type="SP.ContextWebInformation">
*     <d:FormDigestTimeoutSeconds m:type="Edm.Int32">1800</d:FormDigestTimeoutSeconds>
*     <d:FormDigestValue>0x3059FFB920651834540F3E6792EA73F5746B302E953FF4E808E485DB1E6C2836C7CF924644995F092453B02A94DE14A7962674B7B16780AF16EAFB8C246BCDC7,12 Apr 2017 17:08:22 -0000</d:FormDigestValue>
*     <d:LibraryVersion>15.0.4569.1000</d:LibraryVersion>
*     <d:SiteFullUrl>https://SHAREPOINT_HTTPS_DOMAIN</d:SiteFullUrl>
*     <d:SupportedSchemaVersions m:type="Collection(Edm.String)">
*         <d:element>14.0.0.0</d:element>
*         <d:element>15.0.0.0</d:element>
*     </d:SupportedSchemaVersions>
*     <d:WebFullUrl>https://SHAREPOINT_HTTPS_DOMAIN</d:WebFullUrl>
* </d:GetContextWebInformation>
* 

* We'll use the d:FormDigestValue in the X-RequestDigest request header
* for the actual file upload.

* --------------------------------------------------------------------
* Now upload a file named "penguins2.jpg" to the "/Documents" folder.

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.HttpRequest')
loReq = CreateObject('Chilkat.HttpRequest')
loReq.HttpVerb = "POST"
* Change "/Documents" to whatever folder is the destination.
* If your Sharepoint site is within a site collection, then use "/sites/teamA/_api/web/GetFolderByServerRelativeUrl('/sites/teamA/Documents')/Files/add(url='penguins2.jpg',overwrite=true)" where "teamA" is the name of the site.
loReq.Path = "/_api/web/GetFolderByServerRelativeUrl('/Documents')/Files/add(url='penguins2.jpg',overwrite=true)"
* Give the location of the file to be uploaded.  
* Note: The file is not loaded into memory at this point.  It is never fully loaded
* into memory.  Instead, the file data is streamed directly from the file when
* when the upload occurs.
loReq.StreamBodyFromFile("qa_data/jpg/penguins2.jpg")

* Add the X-RequestDigest header field.
loReq.AddHeader("X-RequestDigest",loXml.GetChildContent("d:FormDigestValue"))

* Set the Accept header
loReq.AddHeader("Accept","application/xml")

* Do the upload using https (TLS). Port 443 is the default port for https.
lnBUseTls = 1
loResp = loHttp.SynchronousRequest("SHAREPOINT_HTTPS_DOMAIN",443,lnBUseTls,loReq)
IF (loHttp.LastMethodSuccess <> 1) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loXml
    RELEASE loReq
    CANCEL
ENDIF

* The response body contains XML.  Load it into our xml object..
loXml.LoadXml(loResp.BodyStr)

IF (loResp.StatusCode <> 200) THEN
    ? "Response status code = " + STR(loResp.StatusCode)
    ? loXml.GetXml()
    ? "Failed"
    RELEASE loResp
    RELEASE loHttp
    RELEASE loXml
    RELEASE loReq
    CANCEL
ENDIF

RELEASE loResp

* Show the successful XML response.
? loXml.GetXml()
? "Success."

* A successful XML response looks like this:

* <?xml version="1.0" encoding="utf-8" ?>
* <entry xml:base="https://SHAREPOINT_HTTPS_DOMAIN/_api/" xmlns="http://www.w3.org/2005/Atom" xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns:georss="http://www.georss.org/georss" xmlns:gml="http://www.opengis.net/gml">
*     <id>Web/GetFileByServerRelativeUrl('/Documents/penguins2.jpg')</id>
*     <category term="SP.File" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
*     <link rel="edit" href="Web/GetFileByServerRelativeUrl(&apos;/Documents/penguins2.jpg&apos;)" />
*     <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/Author" type="application/atom+xml;type=entry" title="Author" href="Web/GetFileByServerRelativeUrl(&apos;/Documents/penguins2.jpg&apos;)/Author" />
*     <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/CheckedOutByUser" type="application/atom+xml;type=entry" title="CheckedOutByUser" href="Web/GetFileByServerRelativeUrl(&apos;/Documents/penguins2.jpg&apos;)/CheckedOutByUser" />
*     <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/ListItemAllFields" type="application/atom+xml;type=entry" title="ListItemAllFields" href="Web/GetFileByServerRelativeUrl(&apos;/Documents/penguins2.jpg&apos;)/ListItemAllFields" />
*     <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/LockedByUser" type="application/atom+xml;type=entry" title="LockedByUser" href="Web/GetFileByServerRelativeUrl(&apos;/Documents/penguins2.jpg&apos;)/LockedByUser" />
*     <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/ModifiedBy" type="application/atom+xml;type=entry" title="ModifiedBy" href="Web/GetFileByServerRelativeUrl(&apos;/Documents/penguins2.jpg&apos;)/ModifiedBy" />
*     <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/Versions" type="application/atom+xml;type=feed" title="Versions" href="Web/GetFileByServerRelativeUrl(&apos;/Documents/penguins2.jpg&apos;)/Versions" />
*     <title />
*     <updated>2017-04-12T17:16:44Z</updated>
*     <author>
*         <name />
*     </author>
*     <content type="application/xml">
*         <m:properties>
*             <d:CheckInComment />
*             <d:CheckOutType m:type="Edm.Int32">0</d:CheckOutType>
*             <d:ContentTag>{FC8D1A58-9544-496C-8D9C-19B501A8B322},2,3</d:ContentTag>
*             <d:CustomizedPageStatus m:type="Edm.Int32">0</d:CustomizedPageStatus>
*             <d:ETag>"{FC8D1A58-9544-496C-8D9C-19B501A8B322},2"</d:ETag>
*             <d:Exists m:type="Edm.Boolean">true</d:Exists>
*             <d:Length m:type="Edm.Int64">99832</d:Length>
*             <d:Level m:type="Edm.Byte">255</d:Level>
*             <d:MajorVersion m:type="Edm.Int32">0</d:MajorVersion>
*             <d:MinorVersion m:type="Edm.Int32">1</d:MinorVersion>
*             <d:Name>penguins2.jpg</d:Name>
*             <d:ServerRelativeUrl>/Documents/penguins2.jpg</d:ServerRelativeUrl>
*             <d:TimeCreated m:type="Edm.DateTime">2017-04-12T17:14:19Z</d:TimeCreated>
*             <d:TimeLastModified m:type="Edm.DateTime">2017-04-12T17:16:44Z</d:TimeLastModified>
*             <d:Title m:null="true" />
*             <d:UIVersion m:type="Edm.Int32">1</d:UIVersion>
*             <d:UIVersionLabel>0.1</d:UIVersionLabel>
*         </m:properties>
*     </content>
* </entry>
* 
* 

RELEASE loHttp
RELEASE loXml
RELEASE loReq