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