On this page

    Get-Label

    SYNOPSIS

    Retrieve all labels applied to the given object(s).

    SYNTAX

    Get-ConfluenceLabel -ApiUri <Uri> -Credential <PSCredential> [-PageID] <Int32[]> [-PageSize <Int32>]
 [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>]

    DESCRIPTION

    Currently, this command only returns a label list from wiki pages. It is intended to eventually support other content types as well.

    EXAMPLES

    ————————– 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.

    PARAMETERS

    -ApiUri

    The URi of the API interface. Value can be set persistently with Set-ConfluenceInfo.

    Type: Uri
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

    -Credential

    Confluence’s credentials for authentication. Value can be set persistently with Set-ConfluenceInfo.

    Type: PSCredential
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

    -Certificate

    Certificate for authentication.

    Type: X509Certificate
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

    -PageID

    List the PageID number to check for labels.

    Accepts piped input.

    Type: Int32[]
Parameter Sets: (All)
Aliases: ID

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

    -PageSize

    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.

    Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 25
Accept pipeline input: False
Accept wildcard characters: False

    -IncludeTotalCount

    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.

    Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

    -Skip

    Controls how many things will be skipped before starting output.

    Defaults to 0.

    Type: UInt64
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

    -First

    NOTE: Not yet implemented.

    Indicates how many items to return.

    Type: UInt64
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 18446744073709551615
Accept pipeline input: False
Accept wildcard characters: False

    INPUTS

    OUTPUTS

    ConfluencePS.ContentLabelSet

    NOTES

    https://github.com/AtlassianPS/ConfluencePS