Public/Branches/Get-AspireBranches.ps1
|
<#
.SYNOPSIS Retrieves a list of branches from the Aspire API. .DESCRIPTION Uses Invoke-AspireRequest to perform a GET request to the /Branches endpoint with support for OData query parameters. .PARAMETER Filter Optional OData filter query (e.g., "Name eq 'Main'"). .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., "BranchID,Name"). .PARAMETER Expand Optional comma-separated list of related entities to expand. .PARAMETER OrderBy Optional OData orderby query (e.g., "Name asc"). .PARAMETER PageNumber Optional page number for pagination (integer). .PARAMETER Limit Optional limit for the number of records per page (integer). .OUTPUTS The response from the API containing the list of branches. .EXAMPLE Get-AspireBranches -Filter "Name eq 'Main'" -Top 10 #> function Get-AspireBranches { [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 "/Branches" -QueryParams $queryParams -ApiVersion $null } |