Public/Get/Ticketing/Get-NinjaOneTickets.ps1
|
function Get-NinjaOneTickets { <# .SYNOPSIS Gets tickets from the NinjaOne API. .DESCRIPTION Retrieves tickets from the NinjaOne v2 API. .FUNCTIONALITY Tickets .EXAMPLE PS> Get-NinjaOneTickets -ticketId 1 Gets the ticket with id 1. .EXAMPLE PS> Get-NinjaOneTickets -boardId 1 Gets all tickets for the board with id 1. .EXAMPLE PS> Get-NinjaOneTickets -boardId 1 -filters @{status = 'open'} Gets all open tickets for the board with id 1. .OUTPUTS A powershell object containing the response. .LINK https://docs.homotechsual.dev/modules/ninjaone/commandlets/Get/tickets #> [CmdletBinding()] [OutputType([Object])] [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', '', Justification = 'Uses dynamic parameter parsing.')] Param( # The ticket id to get. [Parameter(Mandatory, ParameterSetName = 'Single', Position = 0, ValueFromPipeline, ValueFromPipelineByPropertyName)] [Alias('id')] [Int]$ticketId, # The board id to get tickets for. [Parameter(Mandatory, ParameterSetName = 'Board', Position = 0, ValueFromPipeline)] [String]$boardId, # The sort rules to apply to the request. Create these using `[NinjaOneTicketBoardSort]::new()`. [Parameter(ParameterSetName = 'Board', Position = 1)] [NinjaOneTicketBoardSort[]]$sort, # Any filters to apply to the request. Create these using `[NinjaOneTicketBoardFilter]::new()`. [Parameter(ParameterSetName = 'Board', Position = 2)] [NinjaOneTicketBoardFilter[]]$filters, # The last cursor id to use for the request. [Parameter(ParameterSetName = 'Board', Position = 3)] [String]$lastCursorId, # The number of results to return. [Parameter(ParameterSetName = 'Board', Position = 4)] [Int]$pageSize, # The search criteria to apply to the request. [Parameter(ParameterSetName = 'Board', Position = 5)] [String]$searchCriteria ) if ($Script:NRAPIConnectionInformation.AuthMode -eq 'Client Credentials') { throw ('This function is not available when using client_credentials authentication. If this is unexpected please report this to api@ninjarmm.com.') exit 1 } try { if ($ticketId) { Write-Verbose ('Getting ticket with id {0}.' -f $ticketId) $Resource = ('v2/ticketing/ticket/{0}' -f $ticketId) $Method = 'GET' } else { Write-Verbouse ('Getting tickets for board with id {0}.' -f $boardId) $Resource = ('v2/ticketing/trigger/board/{0}/run' -f $boardId) $Method = 'POST' } $RequestParams = @{ Resource = $Resource } if ($QSCollection) { $RequestParams.QSCollection = $QSCollection } if ($sort -or $filters -or $lastCursorId -or $searchCriteria) { $RequestParams.Body = [hashtable]@{} } if ($sort) { $RequestParams.Body.sort = $sort } if ($filters) { $RequestParams.Body.filters = $filters } if ($lastCursorId) { $RequestParams.Body.lastCursorId = $lastCursorId } if ($searchCriteria) { $RequestParams.Body.searchCriteria = $searchCriteria } if ($Method -eq 'GET') { $Tickets = New-NinjaOneGETRequest @RequestParams } elseif ($Method -eq 'POST') { $Tickets = New-NinjaOnePOSTRequest @RequestParams } if ($Tickets) { if ($includeMetadata) { return $Tickets } else { # Return just the `data` property which lists the tickets. return $Tickets.data } } else { throw 'No tickets found.' } } catch { New-NinjaOneError -ErrorRecord $_ } } |