Public/ActivityContacts/Get-AspireActivityContacts.ps1
|
<#
.SYNOPSIS Retrieves a list of activity contacts from the Aspire API. .DESCRIPTION Uses Invoke-AspireRequest to perform a GET request to the /ActivityContacts endpoint with support for OData query parameters. .PARAMETER Filter Optional OData filter query (e.g., "ContactID eq 456"). .PARAMETER Top Optional number of records to return (integer). .PARAMETER Skip Optional number of records to skip (integer). .PARAMETER Select Optional comma-separated list of fields to include (e.g., "ContactID,ActivityID"). .PARAMETER Expand Optional comma-separated list of related entities to expand (e.g., "Contact,Activity"). .OUTPUTS The response from the API containing the list of activity contacts. .EXAMPLE Get-AspireActivityContacts -Filter "ContactID eq 456" -Top 10 -Skip 5 -Select "ContactID,ActivityID" -Expand "Contact" #> function Get-AspireActivityContacts { [CmdletBinding()] param( [string]$Filter = $null, [int]$Top = $null, [int]$Skip = $null, [string]$Select = $null, [string]$Expand = $null ) $queryParams = @{} if ($Filter) { $queryParams['$filter'] = $Filter } if ($Top) { $queryParams['$top'] = $Top } if ($Skip) { $queryParams['$skip'] = $Skip } if ($Select) { $queryParams['$select'] = $Select } if ($Expand) { $queryParams['$expand'] = $Expand } return Invoke-AspireRequest -Method GET -Path "/ActivityContacts" -QueryParams $queryParams } |