< Back
Get-JiraFilter
Post
NAME Get-JiraFilter
SYNOPSIS
Returns information about a filter in JIRA
SYNTAX
Get-JiraFilter [-Id] <String[]> [-Credential <PSCredential>] [<CommonParameters>]
Get-JiraFilter -InputObject <Object[]> [-Credential <PSCredential>] [<CommonParameters>]
Get-JiraFilter -Favorite [-Credential <PSCredential>] [<CommonParameters>]
DESCRIPTION
This function returns information about a filter in JIRA, including the JQL syntax of the filter, its owner, and
sharing status.
This function is only capable of returning filters by their Filter ID. This is a limitation of JIRA's REST API.
The easiest way to obtain the ID of a filter is to load the filter in the "regular" Web view of JIRA, then copy
the ID from the URL of the page.
PARAMETERS
-Id <String[]>
ID of the filter to search for.
Required? true
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InputObject <Object[]>
Object of the filter to search for.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Favorite [<SwitchParameter>]
Fetch all filters marked as favorite by the user
Required? true
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Credential <PSCredential>
Credentials to use to connect to JIRA.
If not specified, this function will use anonymous access.
Required? false
Position? named
Default value None
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
[JiraPS.Filter] / [String]
The filter to look up in JIRA. This can be a String (filter ID) or a JiraPS.Filter object.
OUTPUTS
[JiraPS.Filter]
NOTES
This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. See
`New-JiraSession` for more details. If neither are supplied, this function will run with anonymous access to
JIRA.
-------------------------- EXAMPLE 1 --------------------------
Get-JiraFilter -Id 12345
Gets a reference to filter ID 12345 from JIRA
-------------------------- EXAMPLE 2 --------------------------
$filterObject | Get-JiraFilter
Gets the information of a filter by providing a filter object
-------------------------- EXAMPLE 3 --------------------------
Get-JiraFilter -Favorite
Gets all filters makes as "favorite" by the user
RELATED LINKS
Online Version: https://atlassianps.org/docs/JiraPS/com ... iraFilter/
New-JiraFilter
Set-JiraFilter
Remove-JiraFilter
Add-JiraFilterPermission
Get-JiraFilterPermission
Remove-JiraFilterPermission
SYNOPSIS
Returns information about a filter in JIRA
SYNTAX
Get-JiraFilter [-Id] <String[]> [-Credential <PSCredential>] [<CommonParameters>]
Get-JiraFilter -InputObject <Object[]> [-Credential <PSCredential>] [<CommonParameters>]
Get-JiraFilter -Favorite [-Credential <PSCredential>] [<CommonParameters>]
DESCRIPTION
This function returns information about a filter in JIRA, including the JQL syntax of the filter, its owner, and
sharing status.
This function is only capable of returning filters by their Filter ID. This is a limitation of JIRA's REST API.
The easiest way to obtain the ID of a filter is to load the filter in the "regular" Web view of JIRA, then copy
the ID from the URL of the page.
PARAMETERS
-Id <String[]>
ID of the filter to search for.
Required? true
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-InputObject <Object[]>
Object of the filter to search for.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Favorite [<SwitchParameter>]
Fetch all filters marked as favorite by the user
Required? true
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Credential <PSCredential>
Credentials to use to connect to JIRA.
If not specified, this function will use anonymous access.
Required? false
Position? named
Default value None
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
[JiraPS.Filter] / [String]
The filter to look up in JIRA. This can be a String (filter ID) or a JiraPS.Filter object.
OUTPUTS
[JiraPS.Filter]
NOTES
This function requires either the `-Credential` parameter to be passed or a persistent JIRA session. See
`New-JiraSession` for more details. If neither are supplied, this function will run with anonymous access to
JIRA.
-------------------------- EXAMPLE 1 --------------------------
Get-JiraFilter -Id 12345
Gets a reference to filter ID 12345 from JIRA
-------------------------- EXAMPLE 2 --------------------------
$filterObject | Get-JiraFilter
Gets the information of a filter by providing a filter object
-------------------------- EXAMPLE 3 --------------------------
Get-JiraFilter -Favorite
Gets all filters makes as "favorite" by the user
RELATED LINKS
Online Version: https://atlassianps.org/docs/JiraPS/com ... iraFilter/
New-JiraFilter
Set-JiraFilter
Remove-JiraFilter
Add-JiraFilterPermission
Get-JiraFilterPermission
Remove-JiraFilterPermission