Public/Get-NexosisSession.ps1
|
Function Get-NexosisSession { <# .Synopsis Gets the list of sessions that have been created for the company associated with your account. .Description Gets the list of sessions that have been created for the company associated with your account. .Parameter DataSourceName Limits sessions to those for a particular data source. .Parameter EventName Limits impact sessions to those for a particular event .Parameter RequestedAfterDate Limits sessions to those requested on or after the specified date as date-time in ISO8601 format. .Parameter RequestedBeforeDate Limits sessions to those requested on or before the specified date as date-time in ISO8601 format. .Parameter Page Zero-based page number of results to retrieve. .Parameter PageSize Count of Sessions records to retrieve in each page (default 100, max 1000). .Example # Get all the sessions for all datasources (Views, DataSets, etc.) Get-NexosisSession .Example # Retrieve all sessions for a given data source named 'salesdata' Get-NexosisSession -dataSourceName 'salesdata' .Example # Retrieve all sessions that were created after 8-15-2017 for data source named 'salesdata' Get-NexosisSession -dataSourceName 'salesdata' -requestedAfterDate 8-15-2017 #>[CmdletBinding()] Param( [Parameter(Mandatory=$false, ValueFromPipeline=$True)] [string]$dataSourceName, [Parameter(Mandatory=$false, ValueFromPipelineByPropertyName=$true)] [DateTime]$requestedAfterDate, [Parameter(Mandatory=$false, ValueFromPipelineByPropertyName=$true)] [DateTime]$requestedBeforeDate, [Parameter(Mandatory=$false)] [int]$page=0, [Parameter(Mandatory=$false)] [int]$pageSize=$script:PSNexosisVars.DefaultPageSize ) process { if ($page -lt 0) { throw "Parameter '-page' must be an integer greater than or equal to 0." } if (($pageSize -gt ($script:MaxPageSize)) -or ($pageSize -lt 1)) { throw "Parameter '-pageSize' must be an integer between 1 and $script:MaxPageSize." } $params = [System.Web.HttpUtility]::ParseQueryString([String]::Empty) if (($dataSourceName -ne $null) -or ($dataSourceName.Trim().Length -gt 0)) { $params['dataSourceName'] = $dataSourceName } if ($page -ne 0) { $params['page'] = $page } if ($pageSize -ne ($script:PSNexosisVars.DefaultPageSize)) { $params['pageSize'] = $pageSize } elseif ($script:PSNexosisVars.DefaultPageSize -ne $script:ServerDefaultPageSize) { $params['pageSize'] = $script:PSNexosisVars.DefaultPageSize } if ($requestedAfterDate -ne $null) { $params['requestedAfterDate'] = $requestedAfterDate } if ($requestedBeforeDate -ne $null) { $params['requestedBeforeDate'] = $requestedBeforeDate } $response = Invoke-Http -method Get -path 'sessions' -params $params $response.items } } |