On this Page

Snap type:

Read


Description:

This Snap performs a JIRA advanced search by executing a JIRA Query Language (JQL) statement.


Prerequisites:

[None]


Support and limitations:Works in Ultra Task Pipelines.
Account: 

This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. The Snap supports the JIRA basic auth account. The JIRA sites may or may not allow anonymous access.


Views:


InputThis Snap has at most one input view and receives documents in the view. Each document might contain data that is needed to evaluate the JavaScript expression in the Java Query Language (JQL) query property.
OutputThis Snap has exactly one output view and produces documents in the view. Each document contains the response data from the JIRA REST API service endpoint.
ErrorThis Snap has at most one error view and produces zero or more documents in the view. Each document contains the response from the JIRA REST API service endpoint.


Settings

Label


Required. The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.

API version



Required. The JIRA REST API version number.

Example: 2

Default value: 2


JQL


Required. The JQL query statement. It can be a JavaScript expression. See JIRA's Advanced Searching documentation for more information on building query statements.
Example: project=SNAP & updated > -1m
Default value: [None]


startAt

The index of the first issue to return (0-based). Empty value is interpreted as 0.
Example:  10
Default value:  [None]


maxResults

The maximum number of issues to return (defaults to 50). The maximum allowable value is dictated by the JIRA property 'jira.search.views.default.max'. If you specify a value that is higher than this number, your search results will be truncated.
Example:  100
Default value:  [None]


validateQuery

Select this option to validate the JQL query.
Default value:  Selected (true)


fields

A comma-separated list of fields to return for each issue. By default, all navigable fields are returned.
Example:  summary,description,created,updated
Default value:  [None]


expand

A comma-separated list of the parameters to expand.
Example:  renderedFields,transitions,changelog,operations
Default value:  [None]


Ignore empty result

When a JIRA operation produces no result, this property determines if the input document should be passed through to the output view or not. If selected, no document will be written to the output view. If not selected, the input document will be passed through.

Default value:  Selected




Examples

See Also