Get-BTWave

NAME Get-BTWave



SYNOPSIS

Returns Power365 Waves.





SYNTAX

Get-BTWave [-Identity] <object> [-Project <object>] [-Session <Session>] [<CommonParameters>]



Get-BTWave [-Filter <string>] [-Limit <int>] [-Project <object>] [-Session <Session>] [<CommonParameters>]





DESCRIPTION

Get-BTWave -Identity returns the Wave identified by its WaveId, WaveName, or a Wave object.



Get-BTWave [-Project] [-Filter] [-Limit] returns Waves matching selection criteria.



The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTWave cmdlet.





PARAMETERS

-Identity <object>

Wave identity: WaveId, WaveName, or a Wave object.



Required? true

Position? 0

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Project <object>

Limit scope to this Project, specified by ProjectId, ProjectName, or Project object. Defaults to the Session's

default Project, if any.



Required? false

Position? named

Default value System.Object

Accept pipeline input? false

Accept wildcard characters? false



-Filter <string>

Filter expression. The filter is in OPath syntax, such as "WaveName -like 'My*'". The supported properties are

WaveId, WaveName, ProjectId, and ProjectName.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Limit <int>

Limit the number of returned items.



Required? false

Position? named

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-Session <Session>

The Power365 Session in which to run the cmdlet. Defaults to the most recently used Session.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

System.Object

Wave identity: WaveId, WaveName, or a Wave object.





OUTPUTS

BinaryTree.Power365.SDK.Wave





---------- EXAMPLE 1 ----------



Get-BTWave -Identity 986

Get-BTWave -Identity 'My Wave'

Get-BTWave -Identity $wave

Returns a Wave by WaveId, WaveName, or a Wave object.



---------- EXAMPLE 2 ----------



Get-BTWave

Returns all Waves.



---------- EXAMPLE 3 ----------



Get-BTWave -Filter "WaveName -like 'M*'" -Limit 10

Returns the first 10 Waves whose WaveName starts with 'M'.





RELATED LINKS