public class JiraExpressionsApi extends Object
| Constructor and Description |
|---|
JiraExpressionsApi(org.everit.http.restclient.RestClient restClient) |
| Modifier and Type | Method and Description |
|---|---|
io.reactivex.Single<JiraExpressionResult> |
evaluateJiraExpression(JiraExpressionEvalRequestBean jiraExpressionEvalRequestBean,
Optional<String> expand,
Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Evaluate Jira expression
|
public JiraExpressionsApi(org.everit.http.restclient.RestClient restClient)
public io.reactivex.Single<JiraExpressionResult> evaluateJiraExpression(JiraExpressionEvalRequestBean jiraExpressionEvalRequestBean, Optional<String> expand, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)
Evaluates a Jira expression and returns its value.
This resource can be used to test Jira expressions that you plan to use elsewhere, or to fetch data in a flexible way. Consult the Jira expressions documentation for more details.
The following context variables are available to Jira expressions evaluated by this resource. Their presence depends on various factors; usually you need to manually request them in the context object sent in the payload, but some of them are added automatically under certain conditions.
user (User): The current user. Always available and equal to null if the request is anonymous.app (App): The Connect app that made the request. Available only for authenticated requests made by Connect Apps (read more here: Authentication for Connect apps).issue (Issue): The current issue. Available only when the issue is provided in the request context object.issues (List of Issues): A collection of issues matching a given JQL. Available only when the JQL is provided in the request context object (experimental).project (Project): The current project. Available only when the project is provided in the request context object.sprint (Sprint): The current sprint. Available only when the sprint is provided in the request context object.board (Board): The current board. Available only when the board is provided in the request context object.serviceDesk (ServiceDesk): The current service desk. Available only when the service desk is provided in the request context object.customerRequest (CustomerRequest): The current customer request. Available only when the customer request is provided in the request context object.This operation can be accessed anonymously.
Permissions required: None. However, an expression may return different results for different users depending on their permissions. For example, different users may see different comments on the same issue.
Permission to access Jira Software is required to access Jira Software context variables (board and sprint) or fields (for example, issue.sprint).
jiraExpressionEvalRequestBean - The Jira expression and the evaluation context.
(required)expand - Use expand to include additional information in the response. This parameter accepts multiple values separated by a comma:
meta.complexity Returns information about the expression complexity (for example, the number of expensive operations used by the expression) and how close the expression is to reaching the complexity limit. Useful when designing and debugging your expressions.restRequestEnhancer - Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.
Copyright © 2011–2019 Everit Kft.. All rights reserved.