Get-JiraIssueCreateMetadata

NAME Get-JiraIssueCreateMetadata



SYNOPSIS

Returns metadata required to create an issue in JIRA





SYNTAX

Get-JiraIssueCreateMetadata [-Project] <String> [-IssueType] <String> [[-Credential] <PSCredential>]

[<CommonParameters>]





DESCRIPTION

This function returns metadata required to create an issue in JIRA - the fields that can be defined in the process

of creating an issue. This can be used to identify custom fields in order to pass them to `New-JiraIssue`.



This function is particularly useful when your JIRA instance includes custom fields that are marked as mandatory.





PARAMETERS

-Project <String>

Project ID or key of the reference issue.



Required? true

Position? 1

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-IssueType <String>

Issue type ID or name.



Required? true

Position? 2

Default value None

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

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







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-JiraIssueCreateMetadata -Project 'TEST' -IssueType 'Bug'



This example returns the fields available when creating an issue of type Bug under project TEST.

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



Get-JiraIssueCreateMetadata -Project 'JIRA' -IssueType 'Bug' | ? {$_.Required -eq $true}



This example returns fields available when creating an issue of type Bug under the project Jira.



It then uses `Where-Object` (aliased by the question mark) to filter only the fields that are required.



RELATED LINKS

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

about_JiraPS_CreatingIssues

Get-JiraField

New-JiraIssue