< Back
Get-JiraField
Post
NAME Get-JiraField
SYNOPSIS
This function returns information about JIRA fields
SYNTAX
Get-JiraField [-Field] <String[]> [-Credential <PSCredential>] [<CommonParameters>]
DESCRIPTION
This function provides information about JIRA fields, or about one field in particular. This is a good way to
identify a field's ID by its name, or vice versa.
Typically, this information is only needed when identifying what fields are necessary to create or edit issues.
See `Get-JiraIssueCreateMetadata` for more details.
PARAMETERS
-Field <String[]>
The Field name or ID to search.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
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.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.
Remaining operations for `field` have not yet been implemented in the module.
-------------------------- EXAMPLE 1 --------------------------
Get-JiraField
This example returns information about all JIRA fields visible to the current user.
-------------------------- EXAMPLE 2 --------------------------
Get-JiraField "Key"
This example returns information about the Key field.
RELATED LINKS
Online Version: https://atlassianps.org/docs/JiraPS/com ... JiraField/
Get-JiraIssueCreateMetadata
SYNOPSIS
This function returns information about JIRA fields
SYNTAX
Get-JiraField [-Field] <String[]> [-Credential <PSCredential>] [<CommonParameters>]
DESCRIPTION
This function provides information about JIRA fields, or about one field in particular. This is a good way to
identify a field's ID by its name, or vice versa.
Typically, this information is only needed when identifying what fields are necessary to create or edit issues.
See `Get-JiraIssueCreateMetadata` for more details.
PARAMETERS
-Field <String[]>
The Field name or ID to search.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
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.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.
Remaining operations for `field` have not yet been implemented in the module.
-------------------------- EXAMPLE 1 --------------------------
Get-JiraField
This example returns information about all JIRA fields visible to the current user.
-------------------------- EXAMPLE 2 --------------------------
Get-JiraField "Key"
This example returns information about the Key field.
RELATED LINKS
Online Version: https://atlassianps.org/docs/JiraPS/com ... JiraField/
Get-JiraIssueCreateMetadata