Public/Get-NCActiveIssues.ps1
|
<# .SYNOPSIS Retrieves active issues data from the N-central API. .DESCRIPTION The `Get-NCActiveIssues` function retrieves active issues data from the N-central API. It requires an organization unit ID and supports optional parameters for filtering, pagination, sorting, and selecting specific fields. .PARAMETER OrgUnitId The organization unit ID to filter active issues by. This parameter is mandatory. .PARAMETER FilterId The filter ID to apply to the active issues query. .PARAMETER PageNumber The page number to retrieve in a paginated response. .PARAMETER PageSize The number of items per page in a paginated response. .PARAMETER Select Specifies the fields to include in the response. .PARAMETER SortBy The field by which to sort the results. .PARAMETER SortOrder The order to sort the results, either 'asc' for ascending or 'desc' for descending. The default value is 'asc'. .EXAMPLE PS C:\> Get-NCActiveIssues -OrgUnitId 123 -Verbose Retrieves active issues associated with the organization unit ID 123 with verbose output enabled. .EXAMPLE PS C:\> Get-NCActiveIssues -OrgUnitId 123 -PageNumber 1 -PageSize 10 -SortBy "issueType" -SortOrder "desc" Retrieves the first page of active issues with 10 items per page, sorted by issue type in descending order for the organization unit ID 123. .INPUTS None. You cannot pipe input to this function. .OUTPUTS System.Object The function returns active issues data from the N-central API. .NOTES Author: Zach Frazier Website: https://github.com/soybigmac/NCRestAPI #> function Get-NCActiveIssues { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [int]$OrgUnitId, [int]$FilterId, [int]$PageNumber, [int]$PageSize, [string]$Select, [string]$SortBy, [string]$SortOrder = "asc" ) if (-not $global:NCRestApiInstance) { Write-Error "NCRestAPI instance is not initialized. Please run Set-NCRestConfig first." return } $api = $global:NCRestApiInstance Write-Verbose "[FUNCTION] Running Get-NCActiveIssues." $endpoint = "api/org-units/$orgUnitId/active-issues" $queryParameters = @{} if ($PSBoundParameters.ContainsKey('FilterId')) { $queryParameters["filterId"] = $FilterId } if ($PSBoundParameters.ContainsKey('PageNumber')) { $queryParameters["pageNumber"] = $PageNumber } if ($PSBoundParameters.ContainsKey('PageSize')) { $queryParameters["pageSize"] = $PageSize } if ($PSBoundParameters.ContainsKey('Select')) { $queryParameters["select"] = $Select } if ($PSBoundParameters.ContainsKey('SortBy')) { $queryParameters["sortBy"] = $SortBy } if ($PSBoundParameters.ContainsKey('SortOrder')) { $queryParameters["sortOrder"] = $SortOrder } $queryString = if ($queryParameters.Count) { Write-Verbose "[FUNCTION] Query parameters: $queryParameters" $paramsArray = $queryParameters.GetEnumerator() | ForEach-Object { "$($_.Key)=$($_.Value)" } "?" + ($paramsArray -join "&") } else { "" } $endpoint = "$endpoint$queryString" try { Write-Verbose "[FUNCTION] Getting active issues data from endpoint $endpoint." $data = $api.Get($endpoint) return $data } catch { Write-Error "Error retrieving active issues: $_" } } |