Public/Remove-JuribaCustomField.ps1
|
Function Remove-JuribaCustomField { [alias("Remove-DwCustomField")] <# .SYNOPSIS Deletes a custom field. .DESCRIPTION Deletes a custom field using Dashworks API v1. #> [CmdletBinding(SupportsShouldProcess)] param( [Parameter(Mandatory = $false)] [string]$Instance, [Parameter(Mandatory = $false)] [string]$APIKey, [Parameter(Mandatory = $true)] [int]$CustomFieldId ) if ((Get-Variable 'dwConnection' -Scope 'Global' -ErrorAction 'Ignore') -and !$APIKey -and !$Instance) { $APIKey = ConvertFrom-SecureString -SecureString $dwConnection.secureAPIKey -AsPlainText $Instance = $dwConnection.instance } if ($APIKey -and $Instance) { $uri = "{0}/apiv1/custom-fields/{1}" -f $Instance, $CustomFieldId $headers = @{'x-api-key' = $APIKey } if ($PSCmdlet.ShouldProcess($CustomFieldId)) { Invoke-WebRequest -Uri $uri -Method DELETE -Headers $headers -ContentType 'application/json' } } else { Write-Error "No connection found. Please ensure `$APIKey and `$Instance is provided or connect using Connect-Juriba before proceeding." } } |