Get-JiraIssueEditMetadata

NAME Get-JiraIssueEditMetadata



SYNOPSIS

Returns metadata required to change an issue in JIRA





SYNTAX

Get-JiraIssueEditMetadata [-Issue] <String> [[-Credential] <PSCredential>] [<CommonParameters>]





DESCRIPTION

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

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



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





PARAMETERS

-Issue <String>

Issue id or key of the reference issue.



Required? true

Position? 1

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

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-JiraIssueEditMetadata -Issue "TEST-001"



This example returns the fields available when updating the issue "TEST-001".

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



Get-JiraIssueEditMetadata -Issue "TEST-001" | ? {$_.Required -eq $true}



This example returns fields available when updating the issue "TEST-001". 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 ... tMetadata/

about_JiraPS_UpdatingIssues

Get-JiraField

Set-JiraIssue