On this page

    Get-Issue

    SYNOPSIS

    Gets Jira Agile issues across board, backlog, sprint, and epic scopes.

    SYNTAX

    _Board (Default)

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

    _Backlog

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

    _Sprint

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

    _Epic

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

    _BoardEpic

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

    _BoardWithoutEpic

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

    DESCRIPTION

    Get-Issue consolidates Jira Agile issue retrieval endpoints:

    • GET /rest/agile/1.0/board/{boardId}/issue (board scope)
    • GET /rest/agile/1.0/board/{boardId}/backlog (backlog scope)
    • GET /rest/agile/1.0/board/{boardId}/sprint/{sprintId}/issue (sprint scope)
    • GET /rest/agile/1.0/epic/{epicId}/issue (epic scope)
    • GET /rest/agile/1.0/board/{boardId}/epic/{epicId}/issue (board + epic scope)
    • GET /rest/agile/1.0/board/{boardId}/epic/none/issue (board issues with no epic)

    The command supports paging and converts issue results into JiraAgilePS issue objects.

    EXAMPLES

    EXAMPLE 1

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

    Returns issues visible on board 7.

    EXAMPLE 2

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

    Returns backlog issues for board 7.

    EXAMPLE 3

    $board = JiraAgilePS\Get-Board -BoardId 7 -Credential $cred
$sprint = JiraAgilePS\Get-Sprint -Board $board -State Active -Credential $cred | Select-Object -First 1
JiraAgilePS\Get-Issue -Board $board -Sprint $sprint -Credential $cred

    Returns issues for the active sprint.

    EXAMPLE 4

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

    Returns issues for epic 10001.

    EXAMPLE 5

    $board = JiraAgilePS\Get-Board -BoardId 7 -Credential $cred
$epic = [AtlassianPS.JiraAgilePS.Epic]::new(10001)
JiraAgilePS\Get-Issue -Board $board -Epic $epic -Credential $cred

    Returns board-scoped issues for the epic.

    EXAMPLE 6

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

    Returns board issues that are not assigned to an epic.

    PARAMETERS

    -Board

    Board object to query.

    Type: Board
Parameter Sets: _Board, _Backlog, _Sprint, _BoardEpic, _BoardWithoutEpic
Aliases:

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

    -Backlog

    Switch to retrieve backlog issues for the specified board.

    Type: SwitchParameter
Parameter Sets: _Backlog
Aliases:

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

    -Sprint

    One or more sprint objects to retrieve sprint-scoped issues.

    Type: Sprint[]
Parameter Sets: _Sprint
Aliases:

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

    -Epic

    One or more epic objects/identifiers to retrieve epic-scoped issues.

    Type: Epic[]
Parameter Sets: _Epic, _BoardEpic
Aliases:

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

    -WithoutEpic

    Switch to retrieve board issues that have no epic assignment.

    Type: SwitchParameter
Parameter Sets: _BoardWithoutEpic
Aliases:

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

    -PageSize

    Maximum number of issues requested per page.

    Type: UInt32
Parameter Sets: (All)
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.Board

    AtlassianPS.JiraAgilePS.Sprint[]

    AtlassianPS.JiraAgilePS.Epic[]

    OUTPUTS

    AtlassianPS.JiraAgilePS.Issue

    NOTES

    Use Get-JiraAgileIssue in normal module usage. Get-Issue is the source function name.

    Get-BoardConfiguration

    Get-Epic