Public/Get-JiraIssueLinkType.ps1
|
function Get-JiraIssueLinkType { <# .SYNOPSIS Gets available issue link types .DESCRIPTION This function gets available issue link types from a JIRA server. It can also return specific information about a single issue link type. This is a useful function for discovering data about issue link types in order to create and modify issue links on issues. .EXAMPLE C:\PS> Get-JiraIssueLinkType This example returns all available links fron the JIRA server .EXAMPLE C:\PS> Get-JiraIssueLinkType -LinkType 1 This example returns information about the link type with ID 1. .INPUTS This function does not accept pipeline input. .OUTPUTS This function outputs the JiraPS.IssueLinkType object(s) that represent the JIRA issue link type(s). .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. #> [CmdletBinding( DefaultParameterSetName = '_All' )] param( # The Issue Type name or ID to search [Parameter( Position = 0, Mandatory, ParameterSetName = '_Search' )] [ValidateNotNullOrEmpty()] [ValidateScript( { if (("JiraPS.IssueLinkType" -notin $_.PSObject.TypeNames) -and (($_ -isnot [String])) -and (($_ -isnot [Int]))) { $errorItem = [System.Management.Automation.ErrorRecord]::new( ([System.ArgumentException]"Invalid Type for Parameter"), 'ParameterType.NotJiraIssueLinkType', [System.Management.Automation.ErrorCategory]::InvalidArgument, $_ ) $errorItem.ErrorDetails = "Wrong object type provided for IssueLinkType. Expected [JiraPS.IssueLinkType], [String] or [Int], but was $($_.GetType().Name)" $PSCmdlet.ThrowTerminatingError($errorItem) <# #ToDo:CustomClass Once we have custom classes, this check can be done with Type declaration #> } else { return $true } } )] [Object] $LinkType, # Credentials to use to connect to JIRA. # If not specified, this function will use anonymous access. [PSCredential] $Credential ) begin { Write-Verbose "[$($MyInvocation.MyCommand.Name)] Function started" $server = Get-JiraConfigServer -ErrorAction Stop $resourceURi = "$server/rest/api/latest/issueLinkType{0}" } process { Write-DebugMessage "[$($MyInvocation.MyCommand.Name)] ParameterSetName: $($PsCmdlet.ParameterSetName)" Write-DebugMessage "[$($MyInvocation.MyCommand.Name)] PSBoundParameters: $($PSBoundParameters | Out-String)" switch ($PSCmdlet.ParameterSetName) { '_All' { $parameter = @{ URI = $resourceURi -f "" Method = "GET" Credential = $Credential } Write-Debug "[$($MyInvocation.MyCommand.Name)] Invoking JiraMethod with `$parameter" $result = Invoke-JiraMethod @parameter Write-Output (ConvertTo-JiraIssueLinkType -InputObject $result.issueLinkTypes) } '_Search' { # If the link type provided is an int, we can assume it's an ID number. # If it's a String, it's probably a name, though, and there isn't an API call to look up a link type by name. if ($LinkType -is [Int]) { $parameter = @{ URI = $resourceURi -f "/$LinkType" Method = "GET" Credential = $Credential } Write-Debug "[$($MyInvocation.MyCommand.Name)] Invoking JiraMethod with `$parameter" $result = Invoke-JiraMethod @parameter Write-Output (ConvertTo-JiraIssueLinkType -InputObject $result) } else { Write-Output (Get-JiraIssueLinkType -Credential $Credential | Where-Object { $_.Name -like $LinkType }) } } } } end { Write-Verbose "[$($MyInvocation.MyCommand.Name)] Complete" } } |