PowerBuilder

SharePoint -- Create Folder

See more SharePoint Examples

This example shows how to create a new SharePoint folder. PowerBuilder

integer li_rc
long li_Success
oleobject loo_Http
oleobject loo_Req
oleobject loo_Json
long li_BUseTls
oleobject loo_Resp

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

//  To create a folder, we're going to POST to
//  https://SHAREPOINT_HTTPS_DOMAIN/_api/web/folders
//  with a request body containing the following JSON:
//  
//      { "__metadata": { "type": "SP.Folder" }, "ServerRelativeUrl": "/document_library_relative_url/newFolderName"}

//  This example will create a folder named ChilkatTest in /Documents

//  Note: if your Sharepoint site is within a site collection, you must add the site name "/sites/teamA" to both the Path and the ServerRelativeUrl

loo_Req = create oleobject
li_rc = loo_Req.ConnectToNewObject("Chilkat.HttpRequest")

loo_Req.HttpVerb = "POST"
//  If your Sharepoint site is within a site collection, then use "/sites/teamA/_api/web/folders" where "teamA" is the name of the site.
loo_Req.Path = "/_api/web/folders"

//  We need to add a form digest value in the X-RequestDigest header field.
//  See this example for details on
//  how to get (and cache) a form digest value
loo_Req.AddHeader("X-RequestDigest","SHAREPOINT_FORM_DIGEST")

//  Set the Content-Type, and indicate that a JSON response is desired.
loo_Req.ContentType = "application/json;odata=verbose"
loo_Req.AddHeader("Accept","application/json;odata=verbose")

//  Create and add the JSON body.
loo_Json = create oleobject
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")

loo_Json.UpdateString("__metadata.type","SP.Folder")
//  If your Sharepoint site is within a site collection, then use "/sites/teamA/Documents/ChilkatTest" where "teamA" is the name of the site.
loo_Json.UpdateString("ServerRelativeUrl","/Documents/ChilkatTest")
loo_Req.LoadBodyFromString(loo_Json.Emit(),"utf-8")

//  Send the POST using HTTPS (TLS). Port 443 is the default port for https.
li_BUseTls = 1
loo_Resp = create oleobject
li_rc = loo_Resp.ConnectToNewObject("Chilkat.HttpResponse")

li_Success = loo_Http.HttpSReq("SHAREPOINT_HTTPS_DOMAIN",443,li_BUseTls,loo_Req,loo_Resp)
if li_Success = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_Req
    destroy loo_Json
    destroy loo_Resp
    return
end if

//  The response body contains JSON.
loo_Json.Load(loo_Resp.BodyStr)
loo_Json.EmitCompact = 0

//  The expected success response code is 201.
//  (Let's also check for 200, just in case things change..)
if (loo_Resp.StatusCode <> 200) AND (loo_Resp.StatusCode <> 201) then
    Write-Debug "Response status code = " + string(loo_Resp.StatusCode)
    Write-Debug loo_Json.Emit()
    Write-Debug "Failed"
    destroy loo_Http
    destroy loo_Req
    destroy loo_Json
    destroy loo_Resp
    return
end if

//  Show the successful JSON response.
Write-Debug loo_Json.Emit()
Write-Debug "Success."

//  A successful JSON response looks like this:

//  { 
//    "d": { 
//      "__metadata": { 
//        "id": "Web/GetFolderByServerRelativeUrl('/Documents/ChilkatTest')",
//        "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFolderByServerRelativeUrl('/Documents/ChilkatTest')",
//        "type": "SP.Folder"
//      },
//      "Files": { 
//        "__deferred": { 
//          "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFolderByServerRelativeUrl('/Documents/ChilkatTest')/Files"
//        }
//      },
//      "ListItemAllFields": { 
//        "__deferred": { 
//          "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFolderByServerRelativeUrl('/Documents/ChilkatTest')/ListItemAllFields"
//        }
//      },
//      "ParentFolder": { 
//        "__deferred": { 
//          "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFolderByServerRelativeUrl('/Documents/ChilkatTest')/ParentFolder"
//        }
//      },
//      "Properties": { 
//        "__deferred": { 
//          "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFolderByServerRelativeUrl('/Documents/ChilkatTest')/Properties"
//        }
//      },
//      "Folders": { 
//        "__deferred": { 
//          "uri": "https://SHAREPOINT_HTTPS_DOMAIN/_api/Web/GetFolderByServerRelativeUrl('/Documents/ChilkatTest')/Folders"
//        }
//      },
//      "ItemCount": 0,
//      "Name": "ChilkatTest",
//      "ServerRelativeUrl": "/Documents/ChilkatTest",
//      "WelcomePage": ""
//    }
//  }


destroy loo_Http
destroy loo_Req
destroy loo_Json
destroy loo_Resp