Public/Get-GCArchitectScheduleGroups.ps1
|
<# .SYNOPSIS Retrieves a list of architect schedule groups from Genesys Cloud. .DESCRIPTION Queries the Genesys Cloud API to retrieve a paginated list of architect schedule groups. Supports filtering by name and sorting options. API Endpoint: GET /api/v2/architect/schedulegroups .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 schedule groups by name. Supports partial matching. .EXAMPLE Get-GCArchitectScheduleGroups Retrieves the first page of schedule groups with default page size. .EXAMPLE Get-GCArchitectScheduleGroups -Name 'Holiday Group' -PageSize 50 Retrieves schedule groups matching the name 'Holiday Group'. .NOTES Genesys Cloud API: GET /api/v2/architect/schedulegroups #> function Get-GCArchitectScheduleGroups { [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/schedulegroups" return Invoke-GCApiRequest -Endpoint $endpoint -Method GET -QueryParameters $queryParams } |