public/api-v2/search/Invoke-JiraSearchIssues.ps1
|
$JiraSearchExpand = @("renderedFields","names","schema","transitions","operations","editmeta","changelog","versionedRepresentations") #https://developer.atlassian.com/cloud/jira/platform/rest/v2/#api-rest-api-2-search-post function Invoke-JiraSearchIssues { [CmdletBinding()] param ( # The JQL string to execute [Parameter(Mandatory,Position=0)] [string] $Jql, # The index of the first item to return in the page of results (page offset). The base index is 0. [Parameter(Position=1)] [int32] $StartAt=0, # The maximum number of items to return per page. The default is 50 and the maximum is 100. [Parameter(Position=2)] [ValidateRange(1,100)] [int32] $MaxResults=50, # Array of comma-separated lists of fields to return for each issue, use it to retrieve a subset of fields. [Parameter(Position=3)] [string[]] $Fields=@("*navigable"), # Parameter help description [Parameter(Position=4)] [ValidateSet("strict","warn","none")] [string] $QueryValidation="strict", # Used to expand additional attributes [Parameter(Position=5)] [ValidateScript({ Compare-StringArraySubset $JiraSearchExpand $_ })] [string[]] $Expand, # A comma-separated list of up to 5 issue properties to include in the results. [Parameter(Position=6)] [ValidateCount(1,5)] [string[]] $Properties, # Reference fields by their key (rather than ID). The default is false. [Parameter(Position=7)] [Switch] $FieldsByKeys, # Set this flag to use the GET HTTP verb instead of the default POST [Parameter(Position=8)] [switch] $GET, # The JiraContext object to use for the request [Parameter()] [JiraContext] $JiraContext ) process { $functionPath = "/rest/api/2/search" $verb = IIF $GET "GET" "POST" $body = New-Object RestMethodJsonBody @{ jql = $JQL startAt = $StartAt maxResults = $MaxResults fields = $Fields -join ',' validateQuery = $QueryValidation } if($PSBoundParameters.ContainsKey("Expand")){$body.Add("expand",$Expand -join ",")} if($PSBoundParameters.ContainsKey("Properties")){$body.Add("properties",$Properties)} if($PSBoundParameters.ContainsKey("FieldsByKeys")){$body.Add("fieldsByKeys",$true)} if ($GET) { $query = New-Object RestMethodQueryParams $body.Values $method = New-Object RestMethod @($functionPath,$verb,$query) } else { $method = New-Object BodyRestMethod @($functionPath,$verb,$body) } $method.Invoke($JiraContext) } } |