< Back
Get-ConfluenceLabel
Post
NAME Get-ConfluenceLabel
SYNOPSIS
Retrieve all labels applied to the given object(s).
SYNTAX
Get-Label [-PageID] <Int32[]> -ApiUri <Uri> [-Credential <PSCredential>] [-Certificate <X509Certificate>]
[-PageSize <Int32>] [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>]
DESCRIPTION
Currently, this command only returns a label list from wiki pages. It is intended to eventually support other
content types as well.
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[]>
List the PageID number to check for labels.
Accepts piped input.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
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.ContentLabelSet
NOTES
-------------------------- EXAMPLE 1 --------------------------
Get-ConfluenceLabel -PageID 123456
Returns all labels applied to wiki page 123456.
-------------------------- EXAMPLE 2 --------------------------
Get-ConfluencePage -SpaceKey HOTH -Label skywalker | Get-ConfluenceLabel
For all pages in HOTH with the "skywalker" label applied, return the full list of labels found on each page.
RELATED LINKS
Online Version: https://atlassianps.org/docs/Confluence ... Get-Label/
https://github.com/AtlassianPS/ConfluencePS https://github.com/AtlassianPS/ConfluencePS
SYNOPSIS
Retrieve all labels applied to the given object(s).
SYNTAX
Get-Label [-PageID] <Int32[]> -ApiUri <Uri> [-Credential <PSCredential>] [-Certificate <X509Certificate>]
[-PageSize <Int32>] [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>]
DESCRIPTION
Currently, this command only returns a label list from wiki pages. It is intended to eventually support other
content types as well.
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[]>
List the PageID number to check for labels.
Accepts piped input.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
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.ContentLabelSet
NOTES
-------------------------- EXAMPLE 1 --------------------------
Get-ConfluenceLabel -PageID 123456
Returns all labels applied to wiki page 123456.
-------------------------- EXAMPLE 2 --------------------------
Get-ConfluencePage -SpaceKey HOTH -Label skywalker | Get-ConfluenceLabel
For all pages in HOTH with the "skywalker" label applied, return the full list of labels found on each page.
RELATED LINKS
Online Version: https://atlassianps.org/docs/Confluence ... Get-Label/
https://github.com/AtlassianPS/ConfluencePS https://github.com/AtlassianPS/ConfluencePS