Public/Get-AutomateClientExtraFields.ps1
|
function Get-AutomateClientExtraFields { <# .SYNOPSIS Get Extra Data Fields (EDFs) for customer. .DESCRIPTION Connects to the Automate API and returns EDFs for specified client. .PARAMETER ClientId Returns all EDFs for the client. .PARAMETER Title Filters the EDFs by specified EDF title. .PARAMETER ExtraFieldDefinitionId Filters the EDFs by specified EDF ID. .PARAMETER ValueOnly Retrieves only the value of the EDF. .OUTPUTS EDF objects .NOTES Version: 1.0 Author: Kamil Procyszyn Creation Date: 2020-04-23 Purpose/Change: Initial function development .EXAMPLE Get-AutomateClientExtraFields -ClientId 102 .EXAMPLE Get-AutomateClientExtraFields -ClientId 102 -Title 'PatchingSchedule' -ValueOnly $true #> [cmdletbinding(DefaultParameterSetName = 'Title')] param( [Parameter(Mandatory = $true, Position = 0)] [int32] $ClientId, [Parameter(Mandatory = $false, ParameterSetName = 'Title')] [string] $Title, [Parameter(Mandatory = $false, ParameterSetName = 'EdfId')] [int32] $ExtraFieldDefinitionId, [Parameter(Mandatory = $false)] [bool] $ValueOnly = $false ) $Params = @{ Endpoint = "clients/$ClientId/extrafields" Page = 1 } $EDFs = Get-AutomateApiGeneric @Params #Conditions doesn't seem to be respected server side, thus why filtering locally. If ($PSBoundParameters.ContainsKey('Title')) { $EDFs = $EDFs | Where-Object { $_.Title -eq $Title } } If ($PSBoundParameters.ContainsKey('ExtraFieldDefinitionId')){ $EDFs = $EDFs | Where-Object { $_.ExtraFieldDefinitionId -eq $ExtraFieldDefinitionId } } If ($PSBoundParameters.ContainsKey('ValueOnly')) { $EDFs = $EDFs.TextFieldSettings.Value } return $EDFs } |