< Back
Get-ConfluenceChildPage
Post
NAME Get-ConfluenceChildPage
SYNOPSIS
Retrieve the child pages of a given wiki page or pages.
SYNTAX
Get-ChildPage [-PageID] <Int32> -ApiUri <Uri> [-Credential <PSCredential>] [-Certificate <X509Certificate>]
[-Recurse] [-PageSize <Int32>] [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>]
DESCRIPTION
Return all pages directly below the given page(s).
Optionally, the -Recurse parameter will return all child pages, no matter how nested.
PARAMETERS
-ApiUri <Uri>
The URi of the API interface. Value can be set persistently with Set-ConfluenceInfo.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Credential <PSCredential>
Confluence's credentials for authentication. Value can be set persistently with Set-ConfluenceInfo.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Certificate <X509Certificate>
Certificate for authentication.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PageID <Int32>
Filter results by page ID.
Required? true
Position? 1
Default value 0
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-Recurse [<SwitchParameter>]
Get all child pages recursively
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-PageSize <Int32>
Maximum number of results to fetch per call.
This setting can be tuned to get better performance according to the load on the server.
> Warning: too high of a PageSize can cause a timeout on the request.
Required? false
Position? named
Default value 25
Accept pipeline input? False
Accept wildcard characters? false
-IncludeTotalCount [<SwitchParameter>]
> NOTE: Not yet implemented.
Causes an extra output of the total count at the beginning.
Note this is actually a uInt64, but with a custom string representation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Skip <UInt64>
Controls how many things will be skipped before starting output.
Defaults to 0.
Required? false
Position? named
Default value 0
Accept pipeline input? False
Accept wildcard characters? false
-First <UInt64>
> NOTE: Not yet implemented.
Indicates how many items to return.
Required? false
Position? named
Default value 18446744073709551615
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
ConfluencePS.Page
NOTES
Confluence uses hierarchy to help organize content. This command is meant to help provide the intended context
from the command line.
-------------------------- EXAMPLE 1 --------------------------
Get-ConfluenceChildPage -PageID 123456
Get-ConfluencePage -PageID 123456 | Get-ConfluenceChildPage
Two different methods to return all pages directly below page 123456. Both examples should return identical
results.
-------------------------- EXAMPLE 2 --------------------------
Get-ConfluenceChildPage -PageID 123456 -Recurse
Instead of returning only 123456's child pages, return grandchildren, great-grandchildren, and so on.
RELATED LINKS
Online Version: https://atlassianps.org/docs/Confluence ... ChildPage/
https://github.com/AtlassianPS/ConfluencePS https://github.com/AtlassianPS/ConfluencePS
SYNOPSIS
Retrieve the child pages of a given wiki page or pages.
SYNTAX
Get-ChildPage [-PageID] <Int32> -ApiUri <Uri> [-Credential <PSCredential>] [-Certificate <X509Certificate>]
[-Recurse] [-PageSize <Int32>] [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>]
DESCRIPTION
Return all pages directly below the given page(s).
Optionally, the -Recurse parameter will return all child pages, no matter how nested.
PARAMETERS
-ApiUri <Uri>
The URi of the API interface. Value can be set persistently with Set-ConfluenceInfo.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Credential <PSCredential>
Confluence's credentials for authentication. Value can be set persistently with Set-ConfluenceInfo.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Certificate <X509Certificate>
Certificate for authentication.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PageID <Int32>
Filter results by page ID.
Required? true
Position? 1
Default value 0
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-Recurse [<SwitchParameter>]
Get all child pages recursively
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-PageSize <Int32>
Maximum number of results to fetch per call.
This setting can be tuned to get better performance according to the load on the server.
> Warning: too high of a PageSize can cause a timeout on the request.
Required? false
Position? named
Default value 25
Accept pipeline input? False
Accept wildcard characters? false
-IncludeTotalCount [<SwitchParameter>]
> NOTE: Not yet implemented.
Causes an extra output of the total count at the beginning.
Note this is actually a uInt64, but with a custom string representation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Skip <UInt64>
Controls how many things will be skipped before starting output.
Defaults to 0.
Required? false
Position? named
Default value 0
Accept pipeline input? False
Accept wildcard characters? false
-First <UInt64>
> NOTE: Not yet implemented.
Indicates how many items to return.
Required? false
Position? named
Default value 18446744073709551615
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
ConfluencePS.Page
NOTES
Confluence uses hierarchy to help organize content. This command is meant to help provide the intended context
from the command line.
-------------------------- EXAMPLE 1 --------------------------
Get-ConfluenceChildPage -PageID 123456
Get-ConfluencePage -PageID 123456 | Get-ConfluenceChildPage
Two different methods to return all pages directly below page 123456. Both examples should return identical
results.
-------------------------- EXAMPLE 2 --------------------------
Get-ConfluenceChildPage -PageID 123456 -Recurse
Instead of returning only 123456's child pages, return grandchildren, great-grandchildren, and so on.
RELATED LINKS
Online Version: https://atlassianps.org/docs/Confluence ... ChildPage/
https://github.com/AtlassianPS/ConfluencePS https://github.com/AtlassianPS/ConfluencePS