Public/Get-GCArchitectEmergencyGroups.ps1
|
<# .SYNOPSIS Retrieves a list of architect emergency groups from Genesys Cloud. .DESCRIPTION Queries the Genesys Cloud API to retrieve a paginated list of architect emergency groups. Supports filtering by name and sorting options. API Endpoint: GET /api/v2/architect/emergencygroups .PARAMETER PageSize The number of results per page. Default is 25. .PARAMETER PageNumber The page number to retrieve. Default is 1. .PARAMETER SortBy The field to sort results by. .PARAMETER SortOrder The sort order for results. Valid values are 'asc' or 'desc'. .PARAMETER Name Filter emergency groups by name. Supports partial matching. .EXAMPLE Get-GCArchitectEmergencyGroups Retrieves the first page of emergency groups with default page size. .EXAMPLE Get-GCArchitectEmergencyGroups -Name 'Weather Emergency' Retrieves emergency groups matching the name 'Weather Emergency'. .NOTES Genesys Cloud API: GET /api/v2/architect/emergencygroups #> function Get-GCArchitectEmergencyGroups { [CmdletBinding()] param( [Parameter(Mandatory = $false)] [int]$PageSize = 25, [Parameter(Mandatory = $false)] [int]$PageNumber = 1, [Parameter(Mandatory = $false)] [string]$SortBy, [Parameter(Mandatory = $false)] [string]$SortOrder, [Parameter(Mandatory = $false)] [string]$Name ) $queryParams = @{ pageSize = $PageSize pageNumber = $PageNumber } if ($SortBy) { $queryParams['sortBy'] = $SortBy } if ($SortOrder) { $queryParams['sortOrder'] = $SortOrder } if ($Name) { $queryParams['name'] = $Name } $endpoint = "architect/emergencygroups" return Invoke-GCApiRequest -Endpoint $endpoint -Method GET -QueryParameters $queryParams } |