Output/HaloAPI/Public/Get/Get-HaloStatus.ps1
|
#Requires -Version 7 function Get-HaloStatus { <# .SYNOPSIS Gets statuses from the Halo API. .DESCRIPTION Retrieves statuses types from the Halo API - supports a variety of filtering parameters. .OUTPUTS A powershell object containing the response. #> [CmdletBinding( DefaultParameterSetName = 'Multi' )] [OutputType([Object])] [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', '', Justification = 'Uses dynamic parameter parsing.')] Param( # Status ID [Parameter( ParameterSetName = 'Single', Mandatory = $True )] [int64]$StatusID, # Filter by Status type e.g. 'ticket' returns all ticket statuses [Parameter( ParameterSetName = 'Multi' )] [string]$Type, # Show the count of tickets in the results. [Parameter( ParameterSetName = 'Multi' )] [switch]$ShowCounts, # Filter counts to a specific domain: reqs = tickets, opps = opportunities and prjs = projects. [Parameter( ParameterSetName = 'Multi' )] [ValidateSet( 'reqs', 'opps', 'prjs' )] [string]$Domain, # Filter counts to a specific view ID. [Parameter( ParameterSetName = 'Multi' )] [Alias('view_id')] [int32]$ViewID, # Exclude the pending closure status from the response [Parameter( ParameterSetName = 'Multi' )] [switch]$ExcludePending, # Exclude the closed status from the response [Parameter( ParameterSetName = 'Multi' )] [switch]$ExcludeClosed, # Include extra objects in the result. [Parameter( ParameterSetName = 'Single' )] [Switch]$IncludeDetails ) Invoke-HaloPreFlightChecks $CommandName = $MyInvocation.InvocationName $Parameters = (Get-Command -Name $CommandName).Parameters # Workaround to prevent the query string processor from adding a 'StatusID=' parameter by removing it from the set parameters. if ($StatusID) { $Parameters.Remove('StatusID') | Out-Null } $QSCollection = New-HaloQuery -CommandName $CommandName -Parameters $Parameters try { if ($StatusID) { Write-Verbose "Running in single-status mode because '-StatusID' was provided." $Resource = "api/status/$($StatusID)" } else { Write-Verbose 'Running in multi-status mode.' $Resource = 'api/status' } $RequestParams = @{ Method = 'GET' Resource = $Resource AutoPaginateOff = $True QSCollection = $QSCollection ResourceType = 'statuses' } $StatusResults = New-HaloGETRequest @RequestParams Return $StatusResults } catch { $Command = $CommandName -Replace '-', '' $ErrorRecord = @{ ExceptionType = 'System.Exception' ErrorMessage = "$($CommandName) failed." InnerException = $_.Exception ErrorID = "Halo$($Command)CommandFailed" ErrorCategory = 'ReadError' TargetObject = $_.TargetObject ErrorDetails = $_.ErrorDetails BubbleUpDetails = $False } $CommandError = New-HaloErrorRecord @ErrorRecord $PSCmdlet.ThrowTerminatingError($CommandError) } } |