The JIRA Rest Connector functions within a Mule application as a secure opening through which you can access - and act upon - your information in Jira.

Additional Info

Requires Mule Enterprise License

Yes  

Requires Entitlement

Yes  

Mule Version

3.6.0 or higher

Configs


OAuth 1.0a

<jirarest:oauth-config>

Configuration Connector configuration strategy providing OAuth 1.0a authorization for Jira.

Created by Adam Lipka.

Attributes

Name Java Type Description Default Value Required

name

String

The name of this configuration. With this name can be later referenced.

x 

serverUrl

String

x 

consumerKey

String

x 

privateKey

String

x 

issueKey

String

 

tokensObjectStoreName

String

tokensObjectStore

 

persistentStore

boolean

true

 

tokenTtl

int

 

maxTokens

int

 

expirationInterval

int

 

proxyUri

String

 

proxyUsername

String

 

proxyPassword

String

 


Basic Authentication

<jirarest:basic-config>

Connection Management

Connector configuration strategy providing HTTP Basic Authentication for Jira.

Attributes

Name Java Type Description Default Value Required

name

String

The name of this configuration. With this name can be later referenced.

x 

username

String

a username you use to log in into your Jira instance

x 

password

String

a password you use to log in into your Jira instance

x 

serverUrl

String

an absolute URL of your Jira server

x 

issueKey

String

Key of a sample Issue for which metadata will be retrieved, if Datasense is enabled. When omitted, default Issue structure will be used

 

proxyUri

String

 

proxyUsername

String

 

proxyPassword

String

 

Processors


OAuth - Authorize

<jirarest:authorize>

Performs OAuth authorization flow and returns authorization URL.

XML Sample

<jirarest:authorize config-ref="Jirarest"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

Returns

Return Java Type Description

String

HTML string containing authorization URL


OAuth - Unauthorize

<jirarest:unauthorize>

Invalidates stored OAuth access token.

XML Sample

<jirarest:unauthorize config-ref="Jirarest"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

Returns

Return Java Type Description

String

success message


OAuth - Process callback

<jirarest:callback>

Precess Jira OAuth authorization callback, after user has granted access to Jira.

XML Sample

<jirarest:callback config-ref="Jirarest"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

token

String

OAuth request token, default from query param

#[message.inboundProperties.'http.query.params'.oauth_token]

 

verifier

String

OAuth verifier, default from query param

#[message.inboundProperties.'http.query.params'.oauth_verifier]

 

Returns

Return Java Type Description

String

success message


Generic REST request

<jirarest:generic-rest-request>

Generic rest request

XML Sample

<jirarest:generic-rest-request config-ref="Jirarest" httpMethod="#[flowVars.httpMethod]"  url="#[flowVars.url]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

httpMethod

HttpMethod

The Http method which needs to be performed

x 

url

String

relative url endpoint of the rest servise

x 

body

Map<String,Object>

input body of the method

 

Returns

Return Java Type Description

Object

REST response body of type Map<String, Object> or List<Map<String, Object>>


Myself - get logged user

<jirarest:myself>

Get info about currently logged user

XML Sample

<jirarest:myself config-ref="Jirarest"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

Returns

Return Java Type Description

Map<String,Object>

map containing currently logged user


Attachments - Add

<jirarest:attachments-add>

Adds attachment to the issue

XML Sample

<jirarest:attachments-add config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]"  filename="#[flowVars.filename]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

issueKeyOrId

String

The id or key of the issue to add the attachment to

x 

attachmentInputStream

InputStream

stream to upload

#[payload]

 

filename

String

file name of the uploaded attachment

x 

Returns

Return Java Type Description

List<Attachment>

created attachment


Attachments - Get

<jirarest:attachments-get>

Retrieves the content of given attachment.

XML Sample

<jirarest:attachments-get config-ref="Jirarest" attachmentLink="#[flowVars.attachmentLink]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

attachmentLink

String

URL of the attachment

x 

Returns

Return Java Type Description

InputStream

stream of the attachment, caller is responsible for closing the stream


Attachments - Get all from issue

<jirarest:attachments-get-all-from-issue>

Retrieves attachments from given issue.

XML Sample

<jirarest:attachments-get-all-from-issue config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

issueKeyOrId

String

The id or key of the issue

x 

Returns

Return Java Type Description

List<Attachment>

list of attachments from the given issue


Components - Create

<jirarest:components-create>

  DataSense enabled

Creates a new component

XML Sample

<jirarest:components-create config-ref="Jirarest"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

body

Map<String,Object>

component input map

#[payload]

 

Returns

Return Java Type Description

Map<String,Object>

Map with full representation of a JIRA component


Components - Update

<jirarest:components-update>

  DataSense enabled

Updates an existing component

XML Sample

<jirarest:components-update config-ref="Jirarest" id="#[flowVars.id]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

id

String

id of the component

x 

body

Map<String,Object>

component input map

#[payload]

 

Returns

Return Java Type Description

Map<String,Object>

Map with full representation of a JIRA component


Components - Get

<jirarest:components-get>

Gets a component by Id

XML Sample

<jirarest:components-get config-ref="Jirarest"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

id

String

id of the component

#[payload]

 

Returns

Return Java Type Description

Map<String,Object>

Map with full representation of a JIRA component


Components - Delete

<jirarest:components-delete>

Deletes a component by Id

XML Sample

<jirarest:components-delete config-ref="Jirarest" id="#[flowVars.id]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

id

String

id of the component

x 


Groups - Get

<jirarest:groups-get>

Gets a group by group name

XML Sample

<jirarest:groups-get config-ref="Jirarest"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

groupName

String

name of the group

#[payload]

 

expand

String

List of fields to expand. Currently only available expand is "users".

 

Returns

Return Java Type Description

Map<String,Object>

Map with full representation of a JIRA group


Groups - Delete

<jirarest:groups-delete>

Deletes a group by group name

XML Sample

<jirarest:groups-delete config-ref="Jirarest" groupName="#[flowVars.groupName]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

groupName

String

a group to delete

x 

swapGroup

String

a group to transfer visibility restrictions of the group that is being deleted

 


Groups - Create

<jirarest:groups-create>

  DataSense enabled

Creates a new group

XML Sample

<jirarest:groups-create config-ref="Jirarest"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

body

Map<String,Object>

group input map

#[payload]

 

Returns

Return Java Type Description

Map<String,Object>

Map with full representation of a JIRA group


Groups - Add user

<jirarest:groups-add-user>

Adds given user to a group.

XML Sample

<jirarest:groups-add-user config-ref="Jirarest" groupName="#[flowVars.groupName]"  user="#[flowVars.user]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

groupName

String

name of the requested group

x 

user

String

key or name of the user

x 

Returns

Return Java Type Description

Map<String,Object>

Map with full representation of a JIRA group


Groups - Delete user

<jirarest:groups-delete-user>

Removes given user from a group.

XML Sample

<jirarest:groups-delete-user config-ref="Jirarest" groupName="#[flowVars.groupName]"  user="#[flowVars.user]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

groupName

String

name of the requested group

x 

user

String

key or name of the user

x 


Issues - Create

<jirarest:issues-create>

  DataSense enabled

Creates an issue or a sub-task from a input Map

XML Sample

<jirarest:issues-create config-ref="Jirarest"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

body

Map<String,Object>

issue input map

#[payload]

 

Returns

Return Java Type Description

Map<String,Object>

Map with representation of a JIRA Issue


Issues - Update

<jirarest:issues-update>

  DataSense enabled

Updates an issue with input. The issue can either be updated by setting explicit the field value(s) or by using an operation to change the field value.

XML Sample

<jirarest:issues-update config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

issueKeyOrId

String

issue key or issue id

x 

body

Map<String,Object>

issue update input Map

#[payload]

 

Returns

Return Java Type Description

Map<String,Object>

Map with representation of a JIRA Issue


Issues - Get

<jirarest:issues-get>

Returns a full representation of the issue for the given issue key

XML Sample

<jirarest:issues-get config-ref="Jirarest"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

issueKeyOrId

String

issue key or id

#[payload]

 

fields

String

param (which can be specified multiple times) gives a comma-separated list of fields to include in the response. This can be used to retrieve a subset of fields. A particular field can be excluded by prefixing it with a minus. By default, all (*all) fields are returned in this get-issue resource. Note: the default is different when doing a jql search -- the default there is just navigable fields (*navigable).

 

expand

String

comma separated list of entities that you want expanded. (worklog, comments, attachments, etc)

 

Returns

Return Java Type Description

Map<String,Object>

Map with representation of a JIRA Issue


Issues - Delete

<jirarest:issues-delete>

Deletes an issue by issue key or id

XML Sample

<jirarest:issues-delete config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

issueKeyOrId

String

issue key or id

x 

deleteSubtasks

boolean

boolean indicating that any subtasks should also be deleted. If the issue has no subtasks this parameter is ignored. If the issue has subtasks and this parameter is missing or false, then the issue will not be deleted and an error will be returned.

true

 


Issues - Create bulk

<jirarest:issues-create-bulk>

  DataSense enabled

Creates an issues or a sub-tasks from a input Map

XML Sample

<jirarest:issues-create-bulk config-ref="Jirarest"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

body

Map<String,Object>

issues input map

#[payload]

 

Returns

Return Java Type Description

Map<String,Object>

LinkedMap with representation of a JIRA Issue


Assignee - Set on issue

<jirarest:issues-set-assignee>

  DataSense enabled

Sets assignee for requested issue

XML Sample

<jirarest:issues-set-assignee config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

issueKeyOrId

String

issue key or id

x 

body

Map<String,Object>

assignee request input map

#[payload]

 


Comments - Get all

<jirarest:comments-get-all>

Gets comments for requested issue

XML Sample

<jirarest:comments-get-all config-ref="Jirarest"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

issueKeyOrId

String

issue key or id

#[payload]

 

expand

String

optional flags: renderedBody (provides body rendered in HTML)

 

Returns

Return Java Type Description

Map<String,Object>

Map with representation of a JIRA Comments


Comments - Get

<jirarest:comments-get>

Gets a comment by id

XML Sample

<jirarest:comments-get config-ref="Jirarest" id="#[flowVars.id]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

issueKeyOrId

String

issue key or id

#[payload]

 

id

String

comment id

x 

expand

String

optional flags: renderedBody (provides body rendered in HTML)

 

Returns

Return Java Type Description

Map<String,Object>

Map with representation of a JIRA Comment


Comments - Add

<jirarest:comments-add>

  DataSense enabled

Adds new comment to an issue

XML Sample

<jirarest:comments-add config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

issueKeyOrId

String

issue key or id

x 

body

Map<String,Object>

comment create input map

#[payload]

 

expand

String

optional flags: renderedBody (provides body rendered in HTML)

 

Returns

Return Java Type Description

Map<String,Object>

Map with representation of a JIRA Comment


Comments - Update

<jirarest:comments-update>

  DataSense enabled

Updates existing comment

XML Sample

<jirarest:comments-update config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]"  id="#[flowVars.id]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

issueKeyOrId

String

issue key or id

x 

id

String

id of the comment

x 

body

Map<String,Object>

comment update input map

#[payload]

 

expand

String

optional flags: renderedBody (provides body rendered in HTML)

 

Returns

Return Java Type Description

Map<String,Object>

Map with representation of a JIRA Comment


Comments - Delete

<jirarest:comments-delete>

Deletes comment by id

XML Sample

<jirarest:comments-delete config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]"  id="#[flowVars.id]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

issueKeyOrId

String

issue key or id

x 

id

String

id of the comment

x 


Meta - Get

<jirarest:metadata-get>

Returns the meta data for editing an issue. The fields in the editmeta correspond to the fields in the edit screen for the issue. Fields not in the screen will not be in the editemeta.

XML Sample

<jirarest:metadata-get config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

issueKeyOrId

String

issue key or id

x 

Returns

Return Java Type Description

Map<String,Object>

Map with representation of a JIRA Issue metadata


Notify - Send

<jirarest:issues-notify>

  DataSense enabled

Sends a notification (email) to the list or recipients defined in the request.

XML Sample

<jirarest:issues-notify config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

issueKeyOrId

String

issue key or id

x 

body

Map<String,Object>

notification input map

#[payload]

 


Transitions - Get

<jirarest:transitions-get>

Get a list of the transitions possible for this issue by the current user, along with fields that are required and their types.

XML Sample

<jirarest:transitions-get config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

issueKeyOrId

String

issue key or id

x 

transitionId

String

transition id

 

Returns

Return Java Type Description

Map<String,Object>

Map with representation of a JIRA Issue transition


Transitions - Do

<jirarest:transitions-perform>

  DataSense enabled

Perform a transition on an issue. When performing the transition you can update or set other issue fields.

XML Sample

<jirarest:transitions-perform config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

issueKeyOrId

String

issue key or id

x 

body

Map<String,Object>

transition update input map

#[payload]

 


<jirarest:remote-links-get-all>

A sub-resource representing the remote issue links on the issue.

XML Sample

<jirarest:remote-links-get-all config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

issueKeyOrId

String

issue key or id

x 

globalId

String

The id of the remote issue link to be returned. If not provided, all remote links for the issue are returned.

 

Returns

Return Java Type Description

List<Map<String,Object>>

List with representation of a JIRA Issue remote links


<jirarest:remote-links-create>

  DataSense enabled

Creates or updates a remote issue link from a input.

XML Sample

<jirarest:remote-links-create config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

issueKeyOrId

String

issue key or id

x 

body

Map<String,Object>

remote link input map

#[payload]

 

Returns

Return Java Type Description

Map<String,Object>

Map with representation of a JIRA Issue remote link


<jirarest:remote-links-get>

Gets a remote link of an Issue by id

XML Sample

<jirarest:remote-links-get config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]"  linkId="#[flowVars.linkId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

issueKeyOrId

String

issue key or id

x 

linkId

String

remote link id

x 

Returns

Return Java Type Description

Map<String,Object>

Map with representation of a JIRA Issue remote link


<jirarest:remote-links-update>

  DataSense enabled

Updates an existing remote link

XML Sample

<jirarest:remote-links-update config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]"  linkId="#[flowVars.linkId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

issueKeyOrId

String

issue key or id

x 

linkId

String

remote link id

x 

body

Map<String,Object>

remote link input map

#[payload]

 


<jirarest:remote-links-delete>

Deletes a remote link

XML Sample

<jirarest:remote-links-delete config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]"  linkId="#[flowVars.linkId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

issueKeyOrId

String

issue key or id

x 

linkId

String

link id

x 


Votes - Get

<jirarest:votes-get>

Get voters of an issue

XML Sample

<jirarest:votes-get config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

issueKeyOrId

String

issue key or id

x 

Returns

Return Java Type Description

Map<String,Object>

Map with representation of voters


Votes - Add

<jirarest:votes-add>

Cast your vote in favour of an issue.

XML Sample

<jirarest:votes-add config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

issueKeyOrId

String

issue key or id

x 


Votes - Remove

<jirarest:votes-delete>

Remove your vote from an issue. (i.e. "unvote")

XML Sample

<jirarest:votes-delete config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

issueKeyOrId

String

issue key or id

x 


Watchers - Get

<jirarest:watchers-get>

Returns the list of watchers for the issue with the given key.

XML Sample

<jirarest:watchers-get config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

issueKeyOrId

String

issue key or id

x 

Returns

Return Java Type Description

Map<String,Object>

List with representation of watchers


Watchers - Add

<jirarest:watchers-create>

Adds a user to an issue's watcher list.

XML Sample

<jirarest:watchers-create config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]"  userName="#[flowVars.userName]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

issueKeyOrId

String

issue key or id

x 

userName

String

name of the user

x 


Watchers - Remove

<jirarest:watchers-delete>

Removes a user from an issue's watcher list.

XML Sample

<jirarest:watchers-delete config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]"  userName="#[flowVars.userName]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

issueKeyOrId

String

issue key or id

x 

userName

String

name of the user

x 


Worklogs - Get all

<jirarest:worklogs-get-all>

Returns all work logs for an issue.

XML Sample

<jirarest:worklogs-get-all config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

issueKeyOrId

String

issue key or id

x 

Returns

Return Java Type Description

Map<String,Object>

Map with representation of a JIRA Issue worklogs


Worklogs - Add

<jirarest:worklogs-create>

  DataSense enabled

Adds a new worklog entry to an issue.

XML Sample

<jirarest:worklogs-create config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

issueKeyOrId

String

issue key or id

x 

body

Map<String,Object>

worklog input map

#[payload]

 

Returns

Return Java Type Description

Map<String,Object>

Map with representation of a JIRA Issue worklog


Worklogs - Get

<jirarest:worklogs-get>

Returns a specific worklog.

XML Sample

<jirarest:worklogs-get config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]"  id="#[flowVars.id]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

issueKeyOrId

String

issue key or id

x 

id

String

worklog id

x 

Returns

Return Java Type Description

Map<String,Object>

Map with representation of a JIRA Issue worklog


Worklogs - Update

<jirarest:worklogs-update>

Updates an existing worklog entry

XML Sample

<jirarest:worklogs-update config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]"  id="#[flowVars.id]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

issueKeyOrId

String

issue key or id

x 

id

String

worklog id

x 

body

Map<String,Object>

worklog update map

#[payload]

 

adjustEstimate

String

(optional) allows you to provide specific instructions to update the remaining time estimate of the issue. Valid values are "new" - sets the estimate to a specific value "leave"- leaves the estimate as is "auto"- Default option. Will automatically adjust the value based on the new timeSpent specified on the worklog

 

newEstimate

String

(required when "new" is selected for adjustEstimate) the new value for the remaining estimate field.

 

Returns

Return Java Type Description

Map<String,Object>

Map with representation of a JIRA Issue worklog


Worklogs - Delete

<jirarest:worklogs-delete>

Deletes specific worklog entry

XML Sample

<jirarest:worklogs-delete config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]"  id="#[flowVars.id]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

issueKeyOrId

String

issue key or id

x 

id

String

worklog id

x 

adjustEstimate

String

(optional) allows you to provide specific instructions to update the remaining time estimate of the issue. Valid values are "new" - sets the estimate to a specific value "leave"- leaves the estimate as is "manual" - specify a specific amount to increase remaining estimate by "auto"- Default option. Will automatically adjust the value based on the new timeSpent specified on the worklog

 

newEstimate

String

(required when "new" is selected for adjustEstimate) the new value for the remaining estimate field.

 

increaseBy

String

(required when "manual" is selected for adjustEstimate) the amount to increase the remaining estimate by e.g. "2d"

 


Create Meta - Get

<jirarest:create-meta-get>

Returns the meta data for creating issues. This includes the available projects, issue types and fields, including field types and whether or not those fields are required. Projects will not be returned if the user does not have permission to create issues in that project.

XML Sample

<jirarest:create-meta-get config-ref="Jirarest"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

projectIds

String

combined with the projectKeys param, lists the projects with which to filter the results. If absent, all projects are returned. This parameter can be specified multiple times, and/or be a comma-separated list. Specifiying a project that does not exist (or that you cannot create issues in) is not an error, but it will not be in the results.

 

projectKeys

String

combined with the projectIds param, lists the projects with which to filter the results. If null, all projects are returned. This parameter can be specified multiple times, and/or be a comma-separated list. Specifiying a project that does not exist (or that you cannot create issues in) is not an error, but it will not be in the results.

 

issueTypeIds

String

combinded with issuetypeNames, lists the issue types with which to filter the results. If null, all issue types are returned. This parameter can be specified multiple times, and/or be a comma-separated list. Specifiying an issue type that does not exist is not an error.

 

issueTypeNames

String

combinded with issuetypeIds, lists the issue types with which to filter the results. If null, all issue types are returned. This parameter can be specified multiple times, but is NOT interpreted as a comma-separated list. Specifiying an issue type that does not exist is not an error.

 

Returns

Return Java Type Description

Map<String,Object>

Map with representation of a JIRA create meta object


<jirarest:issue-links-create>

  DataSense enabled

Creates an issue link between two issues. The user requires the link issue permission for the issue which will be linked to another issue. The specified link type in the request is used to create the link and will create a link from the first issue to the second issue using the outward description. It also create a link from the second issue to the first issue using the inward description of the issue link type. It will add the supplied comment to the first issue. The comment can have a restriction who can view it. If group is specified, only users of this group can view this comment, if roleLevel is specified only users who have the specified role can view this comment. The user who creates the issue link needs to belong to the specified group or have the specified role.

XML Sample

<jirarest:issue-links-create config-ref="Jirarest"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

body

Map<String,Object>

issue link create map

#[payload]

 

Returns

Return Java Type Description

Map<String,Object>

Map with representation of a JIRA issue link


<jirarest:issue-links-get>

Returns an issue link with the specified id.

XML Sample

<jirarest:issue-links-get config-ref="Jirarest" linkId="#[flowVars.linkId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

linkId

String

id of the link

x 

Returns

Return Java Type Description

Map<String,Object>

Map with representation of a JIRA issue link


<jirarest:issue-links-delete>

Deletes an issue link with the specified id. To be able to delete an issue link you must be able to view both issues and must have the link issue permission for at least one of the issues.

XML Sample

<jirarest:issue-links-delete config-ref="Jirarest" linkId="#[flowVars.linkId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

linkId

String

id of the link

x 


<jirarest:issue-link-types-get-all>

Returns a list of available issue link types, if issue linking is enabled. Each issue link type has an id, a name and a label for the outward and inward link relationship.

XML Sample

<jirarest:issue-link-types-get-all config-ref="Jirarest"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

Returns

Return Java Type Description

Map<String,Object>

Map with representation of a JIRA issue link types


<jirarest:issue-link-types-get>

Returns for a given issue link type id all information about this issue link type.

XML Sample

<jirarest:issue-link-types-get config-ref="Jirarest" issueLinkTypeId="#[flowVars.issueLinkTypeId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

issueLinkTypeId

String

issue link type id

x 

Returns

Return Java Type Description

Map<String,Object>

Map with representation of a JIRA issue link type


<jirarest:issue-link-types-create>

  DataSense enabled

Create a new issue link type.

XML Sample

<jirarest:issue-link-types-create config-ref="Jirarest"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

body

Map<String,Object>

issue link type input map

#[payload]

 

Returns

Return Java Type Description

Map<String,Object>

Map with representation of a JIRA issue link type


<jirarest:issue-link-types-update>

  DataSense enabled

Update the specified issue link type.

XML Sample

<jirarest:issue-link-types-update config-ref="Jirarest" issueLinkTypeId="#[flowVars.issueLinkTypeId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

issueLinkTypeId

String

issue link type id

x 

body

Map<String,Object>

issue link type input map

#[payload]

 

Returns

Return Java Type Description

Map<String,Object>

Map with representation of a JIRA issue link type


<jirarest:issue-link-types-delete>

Delete the specified issue link type.

XML Sample

<jirarest:issue-link-types-delete config-ref="Jirarest" issueLinkTypeId="#[flowVars.issueLinkTypeId]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

issueLinkTypeId

String

issue link type id

x 


Issue Types - Get all

<jirarest:issue-types-get-all>

Returns a list of all issue types visible to the user

XML Sample

<jirarest:issue-types-get-all config-ref="Jirarest"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

Returns

Return Java Type Description

List<Map<String,Object>>

List with representation of a JIRA issue types


Issue Types - Get

<jirarest:issue-types-get>

Returns a full representation of the issue type that has the given id.

XML Sample

<jirarest:issue-types-get config-ref="Jirarest" id="#[flowVars.id]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

id

String

issue type id

x 

Returns

Return Java Type Description

Map<String,Object>

Map with representation of a JIRA issue type


Priorities - Get all

<jirarest:priorities-get-all>

Returns a list of all issue priorities.

XML Sample

<jirarest:priorities-get-all config-ref="Jirarest"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

Returns

Return Java Type Description

List<Map<String,Object>>

List with representation of a JIRA issue priorities


Priorities - Get

<jirarest:priorities-get>

Returns an issue priority.

XML Sample

<jirarest:priorities-get config-ref="Jirarest" id="#[flowVars.id]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

id

String

the id of the priority

x 

Returns

Return Java Type Description

Map<String,Object>

Map with representation of a JIRA issue priority


Statuses - Get all

<jirarest:statuses-get-all>

Returns a list of all issue statuses.

XML Sample

<jirarest:statuses-get-all config-ref="Jirarest"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

Returns

Return Java Type Description

List<Map<String,Object>>

List with representation of a JIRA issue statuses


Statuses - Get

<jirarest:statuses-get>

Returns an issue status.

XML Sample

<jirarest:statuses-get config-ref="Jirarest" idOrName="#[flowVars.idOrName]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

idOrName

String

the id of the status

x 

Returns

Return Java Type Description

Map<String,Object>

Map with representation of a JIRA issue status


Projects - Get all

<jirarest:projects-get-all>

Returns all projects which are visible for the currently logged in user. If no user is logged in, it returns the list of projects that are visible when using anonymous access.

XML Sample

<jirarest:projects-get-all config-ref="Jirarest"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

Returns

Return Java Type Description

List<Map<String,Object>>

List with representation of a JIRA projects


Projects - Get

<jirarest:projects-get>

Gets a full representation of requested project

XML Sample

<jirarest:projects-get config-ref="Jirarest" projectIdOrKey="#[flowVars.projectIdOrKey]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

projectIdOrKey

String

project id or key

x 

Returns

Return Java Type Description

Map<String,Object>

Map with representation of a JIRA project


Projects - Get Components

<jirarest:projects-get-components>

Gets a full representation of the specified project's components.

XML Sample

<jirarest:projects-get-components config-ref="Jirarest" projectIdOrKey="#[flowVars.projectIdOrKey]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

projectIdOrKey

String

project id or key

x 

Returns

Return Java Type Description

List<Map<String,Object>>

List with representation of a JIRA project components


Projects - Get Statuses

<jirarest:projects-get-statuses>

Gets a full representation of the specified project's statuses.

XML Sample

<jirarest:projects-get-statuses config-ref="Jirarest" projectIdOrKey="#[flowVars.projectIdOrKey]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

projectIdOrKey

String

project id or key

x 

Returns

Return Java Type Description

List<Map<String,Object>>

List with representation of a JIRA project statuses


Projects - Get Versions

<jirarest:projects-get-versions>

Gets a full representation of the specified project's versions.

XML Sample

<jirarest:projects-get-versions config-ref="Jirarest" projectIdOrKey="#[flowVars.projectIdOrKey]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

projectIdOrKey

String

project id or key

x 

Returns

Return Java Type Description

List<Map<String,Object>>

List with representation of a JIRA project versions


Project Categories - Get all

<jirarest:project-categories-get-all>

Gets a full representation of the project categories.

XML Sample

<jirarest:project-categories-get-all config-ref="Jirarest"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

Returns

Return Java Type Description

List<Map<String,Object>>

List with representation of a JIRA project categories


Project Categories - Create

<jirarest:project-categories-create>

  DataSense enabled

Create a project category

XML Sample

<jirarest:project-categories-create config-ref="Jirarest"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

body

Map<String,Object>

project category input map

#[payload]

 

Returns

Return Java Type Description

Map<String,Object>

Map with representation of JIRA project category


Project Categories - Get

<jirarest:project-categories-get>

Gets a specific project category

XML Sample

<jirarest:project-categories-get config-ref="Jirarest" id="#[flowVars.id]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

id

String

id of the project category

x 

Returns

Return Java Type Description

Map<String,Object>

Map with representation of JIRA project category


Project Categories - Update

<jirarest:project-categories-update>

  DataSense enabled

Updates a project category

XML Sample

<jirarest:project-categories-update config-ref="Jirarest" id="#[flowVars.id]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

id

String

id of the project category

x 

body

Map<String,Object>

project category input map

#[payload]

 

Returns

Return Java Type Description

Map<String,Object>

Map with representation of JIRA project category


Project Categories - Delete

<jirarest:project-categories-delete>

Deletes a specific project category

XML Sample

<jirarest:project-categories-delete config-ref="Jirarest" id="#[flowVars.id]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

id

String

id of the project category

x 


Search - JQL

<jirarest:search>

  Paged Operation

Searches for issues using JQL.

XML Sample

<jirarest:search config-ref="Jirarest"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

jql

String

a JQL query string

#[payload]

 

validateQuery

boolean

whether to validate the JQL query

false

 

fields

String

the list of fields to return for each issue. By default, all navigable fields are returned.

 

expand

String

A comma-separated list of the parameters to expand.

 

pagingConfiguration

PagingConfiguration

x 

Returns

Return Java Type Description

ProviderAwarePagingDelegate<Map<String,Object>,JiraRestConnector>

Map with representation of JIRA issues


Users - Get

<jirarest:users-get>

Gets requested user

XML Sample

<jirarest:users-get config-ref="Jirarest"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

userName

String

the user name (specify only one)

 

key

String

the user key

 

Returns

Return Java Type Description

Map<String,Object>

Map with representation of JIRA user


Users - Create

<jirarest:users-create>

  DataSense enabled

Create user. By default created user will not be notified with email. If password field is not set then password will be randomly generated.

XML Sample

<jirarest:users-create config-ref="Jirarest"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

body

Map<String,Object>

user input map

#[payload]

 

Returns

Return Java Type Description

Map<String,Object>

Map with representation of JIRA user


Users - Delete

<jirarest:users-delete>

Deletes requested user

XML Sample

<jirarest:users-delete config-ref="Jirarest"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

userName

String

the user name (specify only one)

 

key

String

the user key

 


Users - Get all assignable

<jirarest:users-get-all-assignable>

  Paged Operation

Returns a list of users that match the search string. This resource cannot be accessed anonymously. Please note that this resource should be called with an issue key when a list of assignable users is retrieved for editing. For create only a project key should be supplied. The list of assignable users may be incorrect if it's called with the project key for editing.

XML Sample

<jirarest:users-get-all-assignable config-ref="Jirarest"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

userName

String

user name

 

project

String

the key of the project we are finding assignable users for

 

issueKey

String

the issue key for the issue being edited we need to find assignable users for.

 

pagingConfiguration

PagingConfiguration

x 

Returns

Return Java Type Description

ProviderAwarePagingDelegate<Map<String,Object>,JiraRestConnector>

List with representation of JIRA users


Users - Get all assignable multiproject

<jirarest:users-get-all-assignable-multiproject>

  Paged Operation

Returns a list of users that match the search string and can be assigned issues for all the given projects. This resource cannot be accessed anonymously.

XML Sample

<jirarest:users-get-all-assignable-multiproject config-ref="Jirarest"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

userName

String

user name

#[payload]

 

projectKeys

String

the keys of the projects we are finding assignable users for, comma-separated

 

pagingConfiguration

PagingConfiguration

x 

Returns

Return Java Type Description

ProviderAwarePagingDelegate<Map<String,Object>,JiraRestConnector>

List with representation of JIRA users


<jirarest:users-search>

  Paged Operation

Returns a list of users that match the search string. This resource cannot be accessed anonymously.

XML Sample

<jirarest:users-search config-ref="Jirarest"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

userName

String

user name

#[payload]

 

includeActive

boolean

If true, then active users are included in the results (default true)

true

 

includeInactive

boolean

If true, then inactive users are included in the results (default false)

false

 

pagingConfiguration

PagingConfiguration

x 

Returns

Return Java Type Description

ProviderAwarePagingDelegate<Map<String,Object>,JiraRestConnector>

List with representation of JIRA users


Versions - Create

<jirarest:versions-create>

  DataSense enabled

Create a version

XML Sample

<jirarest:versions-create config-ref="Jirarest"/>

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

body

Map<String,Object>

version input map

#[payload]

 

Returns

Return Java Type Description

Map<String,Object>

Map with representation of JIRA version


Versions - Get

<jirarest:versions-get>

Gets a specific version

XML Sample

<jirarest:versions-get config-ref="Jirarest" id="#[flowVars.id]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

id

String

the id of the version

x 

Returns

Return Java Type Description

Map<String,Object>

Map with representation of JIRA version


Versions - Update

<jirarest:versions-update>

  DataSense enabled

Updates a version

XML Sample

<jirarest:versions-update config-ref="Jirarest" id="#[flowVars.id]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

id

String

the id of the version

x 

body

Map<String,Object>

version input map

#[payload]

 

Returns

Return Java Type Description

Map<String,Object>

Map with representation of JIRA version


Versions - Delete

<jirarest:versions-delete>

Deletes a version

XML Sample

<jirarest:versions-delete config-ref="Jirarest" id="#[flowVars.id]" />

Attributes

Name Java Type Description Default Value Required

config-ref

String

Specify which config to use

x 

id

String

the id of the version

x