Public/Get/Reports/Get-NinjaRMMCustomFieldsReport.ps1
|
using namespace System.Management.Automation #Requires -Version 7 function Get-NinjaRMMCustomFieldsReport { <# .SYNOPSIS Gets the custom fields report from the NinjaRMM API. .DESCRIPTION Retrieves the custom fields report from the NinjaRMM v2 API. .OUTPUTS A powershell object containing the response. #> [CmdletBinding()] [OutputType([Object])] [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSReviewUnusedParameter', '', Justification = 'Uses dynamic parameter parsing.')] Param( # Filter devices. [Alias('df')] [String]$deviceFilter, # Cursor name. [String]$cursor, # Number of results per page. [Int]$pageSize, # Custom fields updated after the specified date. [DateTime]$updatedAfter, # Array of fields. [String[]]$fields, # Get the detailed version of this report. [Switch]$detailed ) $CommandName = $MyInvocation.InvocationName $Parameters = (Get-Command -Name $CommandName).Parameters try { $QSCollection = New-NinjaRMMQuery -CommandName $CommandName -Parameters $Parameters if ($detailed) { $Resource = 'v2/queries/custom-fields-detailed' } else { $Resource = 'v2/queries/custom-fields' } $RequestParams = @{ Method = 'GET' Resource = $Resource QSCollection = $QSCollection } $CustomFieldsReport = New-NinjaRMMGETRequest @RequestParams Return $CustomFieldsReport } catch { $CommandFailedError = [ErrorRecord]::New( [System.Exception]::New( 'Failed to get the custom fields report from NinjaRMM. You can use "Get-Error" for detailed error information.', $_.Exception ), 'NinjaCommandFailed', 'ReadError', $TargetObject ) $PSCmdlet.ThrowTerminatingError($CommandFailedError) } } |