< Back
Find-JiraFilter
Post
NAME Find-JiraFilter
SYNOPSIS
Find JIRA filter(s).
SYNTAX
Find-JiraFilter [[-Name] <String[]>] [[-AccountId] <String>] [[-Owner] <Object>] [[-GroupName] <String>]
[[-Project] <Object>] [[-Fields] <String[]>] [[-Sort] <String>] [-IncludeTotalCount] [-Skip <UInt64>] [-First
<UInt64>] [-Credential <PSCredential>] [<CommonParameters>]
DESCRIPTION
Searches for filters. This operation is similar to Get filters except that the results can be refined to include
filters that have specific attributes. For example, filters with a particular name. When multiple attributes are
specified only filters matching all attributes are returned.
Disclaimer
> This works with Jira Cloud only. It does not work with non-cloud Jira Server (v8.3.1 at the time of this
writing).
PARAMETERS
-Name <String[]>
String used to perform a case-insensitive partial match with name. An exact match can be requested by
including quotes (refer to the examples above).
Required? false
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-AccountId <String>
User AccountId used to return filters with the matching owner.accountId.
Required? false
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Owner <Object>
User Object or user name used to return filters with the matching owner.accountId.
Required? false
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-GroupName <String>
Group name used to return filters that are shared with a group that matches sharePermissions.group.groupname.
Required? false
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Project <Object>
The ID or Key of the Project to search.
Required? false
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Fields <String[]>
Field you would like to select from your issue. By default, all fields are returned.
Allows any combination of the following values:
- description
- favourite
- favouritedCount
- jql
- owner
- searchUrl
- sharePermissions
- subscriptions
- viewUrl
Required? false
Position? 4
Default value 'description','favourite','favouritedCount','jql','owner','searchUrl','sharePermis
sions','subscriptions','viewUrl'
Accept pipeline input? False
Accept wildcard characters? false
-Sort <String>
Orders the results using one of these filter properties:
- description Orders by filter description. Note that this ordering works independently of whether the expand
to display the description field is in use. - favourite_count Orders by favouritedCount. - is_favourite Orders
by favourite. - id Orders by filter id. - name Orders by filter name. - owner Orders by owner.accountId.
Required? false
Position? 5
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-IncludeTotalCount [<SwitchParameter>]
Causes an extra output of the total count at the beginning.
Note this is actually a uInt64, but with a custom string representation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Skip <UInt64>
Controls how many things will be skipped before starting output.
Defaults to 0.
Required? false
Position? named
Default value 0
Accept pipeline input? False
Accept wildcard characters? false
-First <UInt64>
Indicates how many items to return.
Required? false
Position? named
Default value 18446744073709551615
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
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 --------------------------
Find-JiraFilter -Name 'ABC'
This example finds all JIRA filters that include ABC in the name. The search is case insensitive.
-------------------------- EXAMPLE 2 --------------------------
Find-JiraFilter -Name """George Jetsons Filter"""
This example finds a JIRA filter by exact name (case insensitive)
-------------------------- EXAMPLE 3 --------------------------
'My','Your' | Find-JiraFilter
This example demonstrates use of the pipeline to search for multiple filter Name(s). The search is case
insensitive.
-------------------------- EXAMPLE 4 --------------------------
Find-JiraFilter -Name 'My','Your'
This example demonstrates the use of a list of names to search for multiple filter Name(s). The search is case
insensitive.
-------------------------- EXAMPLE 5 --------------------------
Find-JiraFilter -AccountId 'c62dde3418235be1c8424950' -First 3 -Skip 3
This example finds all JIRA filters belonging to a specific owner, and illustrates the use of the -First and -Skip
Paging parameters.
-------------------------- EXAMPLE 6 --------------------------
Find-JiraFilter -Project 'TEST' -First 8
This example finds all JIRA filters belonging to project TEST.
-------------------------- Example 7 --------------------------
Find-JiraFilter -Name """George Jetsons Filter""" -Fields 'description','jql'
This example finds the JIRA filter named "George Jetsons Filter" but only expands the fields listed.
By retrieving only the data really needed, the payload the server sends is reduced, which speeds up the search.
RELATED LINKS
Online Version: https://atlassianps.org/docs/JiraPS/com ... iraFilter/
Get-JiraFilter
Get-JiraProject
Get-JiraUser
SYNOPSIS
Find JIRA filter(s).
SYNTAX
Find-JiraFilter [[-Name] <String[]>] [[-AccountId] <String>] [[-Owner] <Object>] [[-GroupName] <String>]
[[-Project] <Object>] [[-Fields] <String[]>] [[-Sort] <String>] [-IncludeTotalCount] [-Skip <UInt64>] [-First
<UInt64>] [-Credential <PSCredential>] [<CommonParameters>]
DESCRIPTION
Searches for filters. This operation is similar to Get filters except that the results can be refined to include
filters that have specific attributes. For example, filters with a particular name. When multiple attributes are
specified only filters matching all attributes are returned.
Disclaimer
> This works with Jira Cloud only. It does not work with non-cloud Jira Server (v8.3.1 at the time of this
writing).
PARAMETERS
-Name <String[]>
String used to perform a case-insensitive partial match with name. An exact match can be requested by
including quotes (refer to the examples above).
Required? false
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-AccountId <String>
User AccountId used to return filters with the matching owner.accountId.
Required? false
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Owner <Object>
User Object or user name used to return filters with the matching owner.accountId.
Required? false
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-GroupName <String>
Group name used to return filters that are shared with a group that matches sharePermissions.group.groupname.
Required? false
Position? 2
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Project <Object>
The ID or Key of the Project to search.
Required? false
Position? 3
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Fields <String[]>
Field you would like to select from your issue. By default, all fields are returned.
Allows any combination of the following values:
- description
- favourite
- favouritedCount
- jql
- owner
- searchUrl
- sharePermissions
- subscriptions
- viewUrl
Required? false
Position? 4
Default value 'description','favourite','favouritedCount','jql','owner','searchUrl','sharePermis
sions','subscriptions','viewUrl'
Accept pipeline input? False
Accept wildcard characters? false
-Sort <String>
Orders the results using one of these filter properties:
- description Orders by filter description. Note that this ordering works independently of whether the expand
to display the description field is in use. - favourite_count Orders by favouritedCount. - is_favourite Orders
by favourite. - id Orders by filter id. - name Orders by filter name. - owner Orders by owner.accountId.
Required? false
Position? 5
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-IncludeTotalCount [<SwitchParameter>]
Causes an extra output of the total count at the beginning.
Note this is actually a uInt64, but with a custom string representation.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Skip <UInt64>
Controls how many things will be skipped before starting output.
Defaults to 0.
Required? false
Position? named
Default value 0
Accept pipeline input? False
Accept wildcard characters? false
-First <UInt64>
Indicates how many items to return.
Required? false
Position? named
Default value 18446744073709551615
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
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 --------------------------
Find-JiraFilter -Name 'ABC'
This example finds all JIRA filters that include ABC in the name. The search is case insensitive.
-------------------------- EXAMPLE 2 --------------------------
Find-JiraFilter -Name """George Jetsons Filter"""
This example finds a JIRA filter by exact name (case insensitive)
-------------------------- EXAMPLE 3 --------------------------
'My','Your' | Find-JiraFilter
This example demonstrates use of the pipeline to search for multiple filter Name(s). The search is case
insensitive.
-------------------------- EXAMPLE 4 --------------------------
Find-JiraFilter -Name 'My','Your'
This example demonstrates the use of a list of names to search for multiple filter Name(s). The search is case
insensitive.
-------------------------- EXAMPLE 5 --------------------------
Find-JiraFilter -AccountId 'c62dde3418235be1c8424950' -First 3 -Skip 3
This example finds all JIRA filters belonging to a specific owner, and illustrates the use of the -First and -Skip
Paging parameters.
-------------------------- EXAMPLE 6 --------------------------
Find-JiraFilter -Project 'TEST' -First 8
This example finds all JIRA filters belonging to project TEST.
-------------------------- Example 7 --------------------------
Find-JiraFilter -Name """George Jetsons Filter""" -Fields 'description','jql'
This example finds the JIRA filter named "George Jetsons Filter" but only expands the fields listed.
By retrieving only the data really needed, the payload the server sends is reduced, which speeds up the search.
RELATED LINKS
Online Version: https://atlassianps.org/docs/JiraPS/com ... iraFilter/
Get-JiraFilter
Get-JiraProject
Get-JiraUser