New-JiraFilter

NAME New-JiraFilter



SYNOPSIS

Create a new Jira filter.





SYNTAX

New-JiraFilter [[-Credential] <PSCredential>] -Name <String> [-Description <String>] -JQL <String> [-Favorite]

[-WhatIf] [-Confirm] [<CommonParameters>]





DESCRIPTION

Create a new Jira filter.





PARAMETERS

-Name <String>

Name of the filter.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Description <String>

Description for the filter.



Required? false

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-JQL <String>

JQL string which the filter uses for matching issues.



More about JQL at <https://confluence.atlassian.com/displa ... +Searching>



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Favorite [<SwitchParameter>]

Make this new filter a favorite of the user.



Required? false

Position? named

Default value False

Accept pipeline input? True (ByPropertyName)

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? 2

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

Shows what would happen if the cmdlet runs. The cmdlet is not run.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

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.String]







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 --------------------------



New-JiraFilter -Name "My Bugs" -JQL "type = Bug and assignee = currentuser()"



Creates a new filter named "My Bugs"

-------------------------- Example 2 --------------------------



New-JiraFilter -Name "My Bugs" -JQL "type = Bug and assignee = currentuser()" -Favorite



Creates a new filter named "My Bugs" and stores it as favorite

-------------------------- Example 3 --------------------------



$splatNewFilter = @{

Name = "My Bugs"

Description = "collections of bugs assigned to me"

JQL = "type = Bug and assignee = currentuser()"

Favorite = $true

}

New-JiraFilter @splatNewFilter



Creates a new filter named "My Bugs" using splatting



RELATED LINKS

Online Version: https://atlassianps.org/docs/JiraPS/com ... iraFilter/

Get-JiraFilter

Set-JiraFilter

Remove-JiraFilter