< Back
Get-BTProject
Post
NAME Get-BTProject
SYNOPSIS
Returns Power365 Projects.
SYNTAX
Get-BTProject [-Identity] <object> [-Session <Session>] [<CommonParameters>]
Get-BTProject [-Filter <string>] [-Limit <int>] [-Session <Session>] [<CommonParameters>]
DESCRIPTION
Get-BTProject -Identity returns the Project identified by its ProjectId, ProjectName, or a Project object.
Get-BTProject [-Filter] [-Limit] returns Projects matching selection criteria.
The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTProject cmdlet.
PARAMETERS
-Identity <object>
Project identity: ProjectId, ProjectName, or Project object.
Required? true
Position? 0
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Filter <string>
Filter expression. The filter is in OPath syntax, such as "ProjectName -like 'My*'". The supported properties
are ProjectId, ProjectName, and ProjectType.
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
Project identity: ProjectId, ProjectName, or Project object.
OUTPUTS
BinaryTree.Power365.SDK.Project
---------- EXAMPLE 1 ----------
Get-BTProject -Identity 986
Get-BTProject -Identity 'My Project'
Get-BTProject -Identity $project
Returns a Project by ProjectId, ProjectName, or a Project object.
---------- EXAMPLE 2 ----------
Get-BTProject
Returns all Projects.
---------- EXAMPLE 3 ----------
Get-BTProject -Filter "ProjectName -like 'M*'" -Limit 10
Returns the first 10 Projects whose ProjectName begins with 'M'.
RELATED LINKS
SYNOPSIS
Returns Power365 Projects.
SYNTAX
Get-BTProject [-Identity] <object> [-Session <Session>] [<CommonParameters>]
Get-BTProject [-Filter <string>] [-Limit <int>] [-Session <Session>] [<CommonParameters>]
DESCRIPTION
Get-BTProject -Identity returns the Project identified by its ProjectId, ProjectName, or a Project object.
Get-BTProject [-Filter] [-Limit] returns Projects matching selection criteria.
The ApiKey role must be 'Reader' or 'Writer' to run the Get-BTProject cmdlet.
PARAMETERS
-Identity <object>
Project identity: ProjectId, ProjectName, or Project object.
Required? true
Position? 0
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Filter <string>
Filter expression. The filter is in OPath syntax, such as "ProjectName -like 'My*'". The supported properties
are ProjectId, ProjectName, and ProjectType.
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
Project identity: ProjectId, ProjectName, or Project object.
OUTPUTS
BinaryTree.Power365.SDK.Project
---------- EXAMPLE 1 ----------
Get-BTProject -Identity 986
Get-BTProject -Identity 'My Project'
Get-BTProject -Identity $project
Returns a Project by ProjectId, ProjectName, or a Project object.
---------- EXAMPLE 2 ----------
Get-BTProject
Returns all Projects.
---------- EXAMPLE 3 ----------
Get-BTProject -Filter "ProjectName -like 'M*'" -Limit 10
Returns the first 10 Projects whose ProjectName begins with 'M'.
RELATED LINKS