(PowerShell) SharePoint -- Rename File (or Move a File)

Demonstrates how to rename (or move) a SharePoint file.

See FileMoveTo for more details.

Chilkat .NET Downloads Chilkat .NET Assemblies

Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.dll"

# This requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

$http = New-Object Chilkat.Http

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

# This example will both move and rename /Documents/starfish.jpg to /Documents/ChilkatTest/starfish2.jpg

$req = New-Object Chilkat.HttpRequest
$req.HttpVerb = "POST"
$req.Path = "/_api/web/GetFileByServerRelativeUrl('/Documents/starfish.jpg')/MoveTo(newurl='/Documents/ChilkatTest/starfish2.jpg',flags=1)"

# 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
$req.AddHeader("X-RequestDigest","SHAREPOINT_FORM_DIGEST")

# Send the HTTPS POST.
$bUseTls = $true
$resp = $http.SynchronousRequest("SHAREPOINT_HTTPS_DOMAIN",443,$bUseTls,$req)
if ($http.LastMethodSuccess -ne $true) {
    $($http.LastErrorText)
    exit
}

# If failed, the response body contains XML 
$xml = New-Object Chilkat.Xml
$xml.LoadXml($resp.BodyStr)

if ($resp.StatusCode -ne 200) {
    $("Response status code = " + $resp.StatusCode)
    $($xml.GetXml())
    $("Failed")

    exit
}

# If successful, the response body is empty.
$("Success.")