(Perl) SharePoint -- Check Out a File (or Undo a Checkout)

In SharePoint, you can check out a file to make sure nobody can change it before you update it. After updating, you can check in the file. This example shows how to check out a SharePoint file.

Note: To undo a checkout, replace the string "checkout" with "undocheckout" in the line of code that sets the request's path.

Chilkat Perl Downloads Perl Module for Windows, MacOS, Linux, Alpine Linux, Solaris

use chilkat();

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

$http = chilkat::CkHttp->new();

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

# 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 check out the file named "penguins2.jpg" 
# which is located in the "/Documents" folder.

$req = chilkat::CkHttpRequest->new();
$req->put_HttpVerb("POST");
# Note that our path uses GetFileByServerRelativeUrl and not GetFolderByServerRelativeUrl
# Also, if your Sharepoint site is within a site collection, the URL is formatted like this (where "teamA" is the name of the site)
# /sites/teamA/_api/web/GetFileByServerRelativeUrl('/sites/teamA/Documents/penguins2.jpg')/checkout

# Note: To undo a checkout, replace "checkout" with "undocheckout" in the following line of code.
$req->put_Path("/_api/web/GetFileByServerRelativeUrl('/Documents/penguins2.jpg')/checkout");

# 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 POST using HTTPS (TLS). Port 443 is the default port for https.
$bUseTls = 1;
# resp is a HttpResponse
$resp = $http->SynchronousRequest("SHAREPOINT_HTTPS_DOMAIN",443,$bUseTls,$req);
if ($http->get_LastMethodSuccess() != 1) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

# The response body contains XML.
$xml = chilkat::CkXml->new();
$xml->LoadXml($resp->bodyStr());

if ($resp->get_StatusCode() != 200) {
    print "Response status code = " . $resp->get_StatusCode() . "\r\n";
    print $xml->getXml() . "\r\n";
    print "Failed" . "\r\n";

    exit;
}

# Show the successful XML response.
print $xml->getXml() . "\r\n";
print "Success." . "\r\n";

# A successful XML response looks like this:
# <?xml version="1.0" encoding="utf-8" ?>
# <d:CheckOut 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:null="true" />
# 
#