Get Tickets

Generated Cmdlet Help

This page has been generated from the NinjaOne PowerShell module source. To make changes please edit the appropriate PowerShell source file.

SYNOPSIS

Gets tickets from the NinjaOne API.

SYNTAX

Single

Get-NinjaOneTickets [-ticketId] <Int32> [-ProgressAction <ActionPreference>] [<CommonParameters>]

Board

Get-NinjaOneTickets [-boardId] <String> [[-sort] <NinjaOneTicketBoardSort[]>]
 [[-filters] <NinjaOneTicketBoardFilter[]>] [[-lastCursorId] <String>] [[-pageSize] <Int32>]
 [[-searchCriteria] <String>] [[-includeColumns] <String[]>] [-includeMetadata]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Retrieves tickets from the NinjaOne v2 API.

EXAMPLES

EXAMPLE 1

Get-NinjaOneTickets -ticketId 1

Gets the ticket with id 1.

EXAMPLE 2

Get-NinjaOneTickets -boardId 1

Gets all tickets for the board with id 1.

EXAMPLE 3

Get-NinjaOneTickets -boardId 1 -filters @{status = 'open'}

Gets all open tickets for the board with id 1.

PARAMETERS

-ticketId

The ticket id to get.

Type: Int32
Parameter Sets: Single
Aliases: id

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

-boardId

The board id to get tickets for.

Type: String
Parameter Sets: Board
Aliases:

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

-sort

The sort rules to apply to the request. Create these using [NinjaOneTicketBoardSort]::new().

Type: NinjaOneTicketBoardSort[]
Parameter Sets: Board
Aliases:

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

-filters

Any filters to apply to the request. Create these using [NinjaOneTicketBoardFilter]::new().

Type: NinjaOneTicketBoardFilter[]
Parameter Sets: Board
Aliases:

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

-lastCursorId

The last cursor id to use for the request.

Type: String
Parameter Sets: Board
Aliases:

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

-pageSize

The number of results to return.

Type: Int32
Parameter Sets: Board
Aliases:

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

-searchCriteria

The search criteria to apply to the request.

Type: String
Parameter Sets: Board
Aliases:

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

-includeColumns

Inclue the given columns in the response.

Type: String[]
Parameter Sets: Board
Aliases:

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

-includeMetadata

Include the metadata in the response.

Type: SwitchParameter
Parameter Sets: Board
Aliases:

Required: False
Position: 8
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

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

INPUTS

OUTPUTS

A powershell object containing the response.

NOTES

RELATED LINKS

https://docs.homotechsual.dev/modules/ninjaone/commandlets/Get/tickets