Public/Companies/Get-AspireCompanies.ps1
|
<#
.SYNOPSIS Retrieves a list of companies from the Aspire API. .DESCRIPTION Uses Invoke-AspireRequest to perform a GET request to the /Companies endpoint with support for OData query parameters. .PARAMETER Filter Optional OData filter query (e.g., "Active eq true"). .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., "CompanyID,CompanyName"). .PARAMETER Expand Optional comma-separated list of related entities to expand. .PARAMETER OrderBy Optional OData orderby query (e.g., "CompanyName asc"). .PARAMETER PageNumber Optional page number for pagination. .PARAMETER Limit Optional limit for number of records per page. .OUTPUTS The response from the API containing the list of companies. .EXAMPLE Get-AspireCompanies -Filter "Active eq true" -Top 10 #> function Get-AspireCompanies { [CmdletBinding()] param( [string]$Filter = $null, [int]$Top = $null, [int]$Skip = $null, [string]$Select = $null, [string]$Expand = $null, [string]$OrderBy = $null, [int]$PageNumber = $null, [int]$Limit = $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 } if ($OrderBy) { $queryParams['$orderby'] = $OrderBy } if ($PageNumber) { $queryParams['$pageNumber'] = $PageNumber } if ($Limit) { $queryParams['$limit'] = $Limit } return Invoke-AspireRequest -Method GET -Path "/Companies" -QueryParams $queryParams -ApiVersion $null } |