Office PnP PowerShell: Get file CheckOutStatus

%3CLINGO-SUB%20id%3D%22lingo-sub-46279%22%20slang%3D%22en-US%22%3EOffice%20PnP%20PowerShell%3A%20Get%20file%20CheckOutStatus%3C%2FLINGO-SUB%3E%3CLINGO-BODY%20id%3D%22lingo-body-46279%22%20slang%3D%22en-US%22%3E%3CP%3EHow%20to%20check%20for%20publishing%20page's%20CheckOutStatus%3F%3C%2FP%3E%3CP%3E%26nbsp%3B%3C%2FP%3E%3CPRE%3E%20%20%20%20%20%20%20%20%23%20Get%20pages%0A%20%20%20%20%20%20%20%20foreach(%24page%20in%20Get-PnPListItem%20-Web%20%24subweb%20-List%20%22pages%22%20-Fields%20%22FileRef%22%20%7C%20Where%20%7B%20%24_.FieldValues.FSObjType%20-eq%200%7D)%0A%20%20%20%20%20%20%20%20%7B%20%20%20%20%20%20%20%0A%20%20%20%20%20%20%20%20%20%20%20%20Write-Host%20%22Page%20'%24(%24page%5B%22FileRef%22%5D)'%22%0A%20%20%20%20%20%20%20%20%20%20%20%20%24file%20%3D%20Get-PnPFile%20-Url%20%24page%5B%22FileRef%22%5D%20-Web%20%24subweb%0A%20%20%20%20%20%20%20%20%20%20%20%20%24file.CheckOutStatus%20%23NONONO!%3C%2FPRE%3E%3C%2FLINGO-BODY%3E%3CLINGO-SUB%20id%3D%22lingo-sub-176994%22%20slang%3D%22en-US%22%3ERe%3A%20Office%20PnP%20PowerShell%3A%20Get%20file%20CheckOutStatus%3C%2FLINGO-SUB%3E%3CLINGO-BODY%20id%3D%22lingo-body-176994%22%20slang%3D%22en-US%22%3E%3CP%3EI%20have%20managed%20to%20get%20the%20checked%20out%20status%20of%20a%20file%20this%20way%20%3A%26nbsp%3B%3C%2FP%3E%0A%3CP%3E%26nbsp%3B%3C%2FP%3E%0A%3CPRE%3E%24lists%20%3D%20Get-PnPList%0Aforeach%20(%24list%20in%20%24lists%20%7C%20where%20%7B%24_.Title%20-eq%20%22Site%20Pages%22%20-or%20%24_.Title%20-eq%20%22Documents%22%7D)%0A%7B%0A%20%20%20%20%24Items%20%3D%20Get-PnPListItem%20-List%20%24list%0A%20%20%20%20foreach%20(%24Item%20in%20%24Items)%20%0A%20%20%20%20%7B%0A%20%20%20%20%20%20%20%20if%20(%24Item.FieldValues.CheckoutUser%20-ne%20%24null)%0A%20%20%20%20%20%20%20%20%7B%0A%20%20%20%20%20%20%20%20%20%20%20%20write-host%20%24list.Title%20-ForegroundColor%20Green%0A%20%20%20%20%20%20%20%20%20%20%20%20write-host%20(%24Item.FieldValues).FileLeafRef%20-ForegroundColor%20Yellow%0A%20%20%20%20%20%20%20%20%20%20%20%20write-host%20%24Item.FieldValues.CheckoutUser.Email%20-ForegroundColor%20Red%0A%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%7D%0A%7D%0A%3C%2FPRE%3E%0A%3CP%3E%26nbsp%3B%3C%2FP%3E%0A%3CP%3EIf%20the%20item%20is%20checked%20out%20(in%20either%20%22Site%20Pages%22%20or%20%22Documents%22%2C%20in%20this%20example)%2C%20this%20script%20will%20show%20you%20the%20filename%2C%20and%20the%20email%20of%20the%20person%20who%20has%20it%20checked%20out.%3C%2FP%3E%3C%2FLINGO-BODY%3E%3CLINGO-SUB%20id%3D%22lingo-sub-86729%22%20slang%3D%22en-US%22%3ERe%3A%20Office%20PnP%20PowerShell%3A%20Get%20file%20CheckOutStatus%3C%2FLINGO-SUB%3E%3CLINGO-BODY%20id%3D%22lingo-body-86729%22%20slang%3D%22en-US%22%3E%3CP%3EUsing%20%3CEM%3E%24context.Load%3C%2FEM%3E%20and%20%3CEM%3EExecuteQuery%3C%2FEM%3E%20does%20the%20trick%20%3CEM%3E%24file.Level%3C%2FEM%3E%20is%20loaded.%20However%20if%20using%20%3CEM%3EGet-PnPFile%3C%2FEM%3E%20or%20%3CEM%3EGet-PnPListItem%3C%2FEM%3E%20the%20%3CEM%3ELevel%3C%2FEM%3E%20attribute%20seems%20to%20not%20be%20loaded.%3C%2FP%3E%3CP%3E%26nbsp%3B%3C%2FP%3E%3CP%3EI%20didn't%20find%20a%20way%20to%20include%20more%20fields%20besides%20using%20the%20full%20execute%20query.%20Maybe%20a%20bug%20%2F%20feature%20request%3F%3C%2FP%3E%3C%2FLINGO-BODY%3E%3CLINGO-SUB%20id%3D%22lingo-sub-46460%22%20slang%3D%22en-US%22%3ERe%3A%20Office%20PnP%20PowerShell%3A%20Get%20file%20CheckOutStatus%3C%2FLINGO-SUB%3E%3CLINGO-BODY%20id%3D%22lingo-body-46460%22%20slang%3D%22en-US%22%3E%3CP%3EPlease%20try%20the%20below%20modified%20script.%3C%2FP%3E%3CP%3E%26nbsp%3B%3C%2FP%3E%3CPRE%3E%24cred%3DGet-Credential%20%0AConnect-PnPOnline%20-Url%20https%3A%2F%2Fitrmxxxx.sharepoint.com%2Fsites%2Fcontosobeta%20-Credentials%20%24cred%0A%20%20%20%0A%20%20%20%24subwebs%3DGet-PnPSubWebs%20-Recurse%0A%0A%20%20%20%20foreach(%24subweb%20in%20%24subwebs)%0A%20%20%20%20%7B%0A%20%20%20%20%20%20%20%20Write-Host%20%22Subweb%20'%24(%24subweb.Title)'%22%0A%0A%20%20%20%20%20%20%20%20Connect-PnPOnline%20-Url%20%24subweb.Url%20-Credentials%20%24cred%0A%20%20%20%20%20%20%20%20%0A%20%20%20%20%20%20%20%20%24context%20%3D%20Get-PnPContext%0A%0A%20%20%20%20%20%20%20%20%24list%20%3D%20Get-PnPList%20-Identity%20%22Documents%22%20%0A%20%20%20%20%20%20%20%20%0A%20%20%20%20%20%20%20%20%24allfiles%20%3D%20%24list.RootFolder.Files%0A%20%20%20%20%20%20%20%20%24context.Load(%24allfiles)%0A%20%20%20%20%20%20%20%20%24context.ExecuteQuery()%0A%0A%20%20%20%20%20%20%20%20foreach(%24file%20in%20%24allfiles)%20%20%20%20%20%20%20%20%0A%20%20%20%20%20%20%20%20%7B%20%20%20%0A%20%20%20%20%20%20%20%20%20%20%20%20Write-Host%20%22Page%20'%24(%24file.ServerRelativeUrl)'%22%0A%20%20%20%20%20%20%20%20%20%20%20%20%0A%20%20%20%20%20%20%20%20%20%20%20%20write-host%20%24file.Level%0A%20%20%20%20%20%20%20%20%20%7D%0A%20%20%20%20%20%20%20%24Context.Dispose()%0A%20%20%20%20%20%20%20%24context.ExecuteQuery()%0A%7D%20%3C%2FPRE%3E%3C%2FLINGO-BODY%3E%3CLINGO-SUB%20id%3D%22lingo-sub-46440%22%20slang%3D%22en-US%22%3ERe%3A%20Office%20PnP%20PowerShell%3A%20Get%20file%20CheckOutStatus%3C%2FLINGO-SUB%3E%3CLINGO-BODY%20id%3D%22lingo-body-46440%22%20slang%3D%22en-US%22%3E%3CP%3EThanks%2C%20looks%20like%20it%20cannot%20really%20be%20done%20with%20PnP.%3C%2FP%3E%3CP%3E%26nbsp%3B%3C%2FP%3E%3CP%3EHow%20come%20the%20-Web%20parameter%20isn't%20working%20when%20looping%20subsites%2C%20it%20is%20compaining%20about%20wrong%20context%3A%3C%2FP%3E%3CP%3E%26nbsp%3B%3C%2FP%3E%3CPRE%3E%20%20%20%20foreach(%24subweb%20in%20Get-PnPSubWebs%20-Recurse)%0A%20%20%20%20%7B%0A%20%20%20%20%20%20%20%20Write-Host%20%22Subweb%20'%24(%24subweb.Title)'%22%0A%20%20%20%20%20%20%20%20%0A%20%20%20%20%20%20%20%20%24context%20%3D%20Get-PnPContext%0A%0A%20%20%20%20%20%20%20%20%24list%20%3D%20Get-PnPList%20-Identity%20%22pages%22%20-Web%20%24subweb%20%23%20%26lt%3B%26lt%3B%26lt%3B%20Here%20I%20need%20to%20get%20hold%20of%20current%20subweb%20pages%20%20%20%20%20%0A%20%20%20%20%20%20%20%20%0A%20%20%20%20%20%20%20%20%24allfiles%20%3D%20%24list.RootFolder.Files%0A%20%20%20%20%20%20%20%20%24context.Load(%24allfiles)%0A%20%20%20%20%20%20%20%20%24context.ExecuteQuery()%0A%0A%20%20%20%20%20%20%20%20foreach(%24file%20in%20%24allfiles)%20%20%20%20%20%20%20%20%0A%20%20%20%20%20%20%20%20%7B%20%20%20%0A%20%20%20%20%20%20%20%20%20%20%20%20Write-Host%20%22Page%20'%24(%24file.ServerRelativeUrl)'%22%0A%20%20%20%20%20%20%20%20%20%20%20%20%0A%20%20%20%20%20%20%20%20%20%20%20%20write-host%20%24file.Level%0A%20%20%20%20%20%20%20%20%20%7D%0A%7D%3C%2FPRE%3E%3C%2FLINGO-BODY%3E%3CLINGO-SUB%20id%3D%22lingo-sub-46427%22%20slang%3D%22en-US%22%3ERe%3A%20Office%20PnP%20PowerShell%3A%20Get%20file%20CheckOutStatus%3C%2FLINGO-SUB%3E%3CLINGO-BODY%20id%3D%22lingo-body-46427%22%20slang%3D%22en-US%22%3E%3CP%3ECheck%20the%20below%20sample%20to%20get%20the%20file%20checkout%20status%20using%20PnP.%3C%2FP%3E%3CP%3E%26nbsp%3B%3C%2FP%3E%3CPRE%3E%24DocLibName%20%3D%20%22Documents%22%0A%24Context%20%3DGet-PnPContext%0A%24List%3DGet-PnPList%20-Identity%20%22Documents%22%0A%24Allfiles%3D%20%24List.RootFolder.Files%0A%24Context.Load(%24Allfiles)%0A%24Context.ExecuteQuery()%0Aforeach(%20%24file%20in%20%24Allfiles)%0A%7B%0AWrite-Host%20%22FileName%22%20%24file.Name%20%22Status%22%20%24file.Level%0A%7D%20%20%3C%2FPRE%3E%3CP%3E%26nbsp%3B%3C%2FP%3E%3CP%3E%26nbsp%3B%3C%2FP%3E%3C%2FLINGO-BODY%3E
Highlighted
Contributor

How to check for publishing page's CheckOutStatus?

 

        # Get pages
        foreach($page in Get-PnPListItem -Web $subweb -List "pages" -Fields "FileRef" | Where { $_.FieldValues.FSObjType -eq 0})
        {       
            Write-Host "Page '$($page["FileRef"])'"
            $file = Get-PnPFile -Url $page["FileRef"] -Web $subweb
            $file.CheckOutStatus #NONONO!
5 Replies
Highlighted

Check the below sample to get the file checkout status using PnP.

 

$DocLibName = "Documents"
$Context =Get-PnPContext
$List=Get-PnPList -Identity "Documents"
$Allfiles= $List.RootFolder.Files
$Context.Load($Allfiles)
$Context.ExecuteQuery()
foreach( $file in $Allfiles)
{
Write-Host "FileName" $file.Name "Status" $file.Level
}  

 

 

Highlighted

Thanks, looks like it cannot really be done with PnP.

 

How come the -Web parameter isn't working when looping subsites, it is compaining about wrong context:

 

    foreach($subweb in Get-PnPSubWebs -Recurse)
    {
        Write-Host "Subweb '$($subweb.Title)'"
        
        $context = Get-PnPContext

        $list = Get-PnPList -Identity "pages" -Web $subweb # <<< Here I need to get hold of current subweb pages     
        
        $allfiles = $list.RootFolder.Files
        $context.Load($allfiles)
        $context.ExecuteQuery()

        foreach($file in $allfiles)        
        {   
            Write-Host "Page '$($file.ServerRelativeUrl)'"
            
            write-host $file.Level
         }
}
Highlighted

Please try the below modified script.

 

$cred=Get-Credential 
Connect-PnPOnline -Url https://itrmxxxx.sharepoint.com/sites/contosobeta -Credentials $cred
   
   $subwebs=Get-PnPSubWebs -Recurse

    foreach($subweb in $subwebs)
    {
        Write-Host "Subweb '$($subweb.Title)'"

        Connect-PnPOnline -Url $subweb.Url -Credentials $cred
        
        $context = Get-PnPContext

        $list = Get-PnPList -Identity "Documents" 
        
        $allfiles = $list.RootFolder.Files
        $context.Load($allfiles)
        $context.ExecuteQuery()

        foreach($file in $allfiles)        
        {   
            Write-Host "Page '$($file.ServerRelativeUrl)'"
            
            write-host $file.Level
         }
       $Context.Dispose()
       $context.ExecuteQuery()
} 
Highlighted

Using $context.Load and ExecuteQuery does the trick $file.Level is loaded. However if using Get-PnPFile or Get-PnPListItem the Level attribute seems to not be loaded.

 

I didn't find a way to include more fields besides using the full execute query. Maybe a bug / feature request?

Highlighted

I have managed to get the checked out status of a file this way : 

 

$lists = Get-PnPList
foreach ($list in $lists | where {$_.Title -eq "Site Pages" -or $_.Title -eq "Documents"})
{
    $Items = Get-PnPListItem -List $list
    foreach ($Item in $Items) 
    {
        if ($Item.FieldValues.CheckoutUser -ne $null)
        {
            write-host $list.Title -ForegroundColor Green
            write-host ($Item.FieldValues).FileLeafRef -ForegroundColor Yellow
            write-host $Item.FieldValues.CheckoutUser.Email -ForegroundColor Red
        }
    }
}

 

If the item is checked out (in either "Site Pages" or "Documents", in this example), this script will show you the filename, and the email of the person who has it checked out.