On this page

    Get-JiraField

    SYNOPSIS

    This function returns information about JIRA fields

    SYNTAX

    _All (Default)

    Get-JiraField [-Credential <PSCredential>] [<CommonParameters>]

    _Search

    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.

    EXAMPLES

    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.

    PARAMETERS

    -Field

    The Field name or ID to search.

    Type: String[]
Parameter Sets: _Search
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

    -Credential

    Credentials to use to connect to JIRA.
    If not specified, this function will use anonymous access.

    Type: PSCredential
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

    CommonParameters

    This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://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.

    Get-JiraIssueCreateMetadata