Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

For a sample proxy service that illustrates how to work with search, see Sample configuration .

OperationDescription
1Working with Search in JIRAsearchJiraSearch in JIRA using JQL.

Following is more information about these operations.

Searching for issues
Anchor
searchJira
searchJira

To get an existing issue, use searchJira and specify theJQL query.

Code Block
languagehtml/xml
titlesearchJira
<jira.searchJira>
	<query>{$ctx:query}</query>
	<maxResults>{$ctx:maxResults}</maxResults>
	<startAt>{$ctx:startAt}</startAt>
	<fields>{$ctx:fields}</fields>
	<validateQuery>{$ctx:validateQuery}</validateQuery>
	<expand>{$ctx:expand}</expand>
</jira.searchJira>
Properties
  • query: The JQL expression to use for finding issues. The query must include an ORDER BY clause. For more information, see Advanced Searching in the JIRA documentation.
  • maxResults: Optional. The maximum number of issues to return, up to 1000 (default is 50).
  • startAt : Optional. The 0-based index of the first issue to return (default is 0).
  • fields : Specifies a comma-separated list of fields to be included in the response.
  • validateQuery : Specify whether to validate the JQL query.
  • expand : A comma-separated list of the parameters to expand.
Anchor
samReq
samReq
Sample request

Following is a sample REST/JSON request that can be handled by the searchJira operation.

Code Block
languagexml
titleSample request for searchJira
{
    "username":"admin",
    "password":"jira@jaffna",       
    "uri":"https://testcon.atlassian.net",        
    "query":"text~\"issue2\""
}
Related JIRA API

https://developer.atlassian.com/static/rest/jira/6.1.html#d2e1160

Anchor
sampleProxy
sampleProxy
Sample Configuration

Following is a sample proxy service that illustrates how to connect to Jira with the init operation and use the searchJira operation. The sample request for this proxy can be found in searchJira sample request.You can use this sample as a template for using other operations in this category.

...