On this page

    Get-Epic

    SYNOPSIS

    Gets details for one or more Jira Agile epics.

    SYNTAX

    _ById (Default)

    Get-Epic [-Epic] <Epic[]> [[-PageSize] <UInt32>] [-Credential <PSCredential>] [<CommonParameters>]

    _ByBoard

    Get-Epic [-Board] <Board> [[-PageSize] <UInt32>] [-Credential <PSCredential>] [<CommonParameters>]

    DESCRIPTION

    Get-Epic supports:

    • GET /rest/agile/1.0/epic/{epicId}
    • GET /rest/agile/1.0/board/{boardId}/epic

    Returns JiraAgilePS epic objects for direct epic lookup or board-scoped epic listing.

    EXAMPLES

    EXAMPLE 1

    $epic = [AtlassianPS.JiraAgilePS.Epic]::new(10001)
JiraAgilePS\Get-Epic -Epic $epic -Credential $cred

    Returns details for epic 10001.

    EXAMPLE 2

    $board = JiraAgilePS\Get-Board -BoardId 7 -Credential $cred
JiraAgilePS\Get-Epic -Board $board -Credential $cred

    Returns epics associated with board 7.

    PARAMETERS

    -Epic

    One or more epic objects/identifiers to query.

    Type: Epic[]
Parameter Sets: _ById
Aliases:

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

    -Board

    Board object used for board-scoped epic retrieval.

    Type: Board
Parameter Sets: _ByBoard
Aliases:

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

    -PageSize

    Maximum number of epics requested per page.

    Type: UInt32
Parameter Sets: _ByBoard
Aliases:

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

    -Credential

    Credentials used for Jira authentication.

    Type: PSCredential
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: [System.Management.Automation.PSCredential]::Empty
Accept pipeline input: False
Accept wildcard characters: False

    -IncludeTotalCount

    Causes an extra output of the total count at the beginning of paged output.

    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 items are skipped before output starts.

    Type: UInt64
Parameter Sets: (All)
Aliases:

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

    -First

    Controls how many items are returned.

    Type: UInt64
Parameter Sets: (All)
Aliases:

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

    CommonParameters

    This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

    INPUTS

    AtlassianPS.JiraAgilePS.Epic

    AtlassianPS.JiraAgilePS.Board

    OUTPUTS

    AtlassianPS.JiraAgilePS.Epic

    NOTES

    Use Get-JiraAgileEpic in normal module usage. Get-Epic is the source function name.

    Get-Issue