org.mule.modules

mule-module-jira

config

Namespace	http://www.mulesoft.org/schema/mule/jira
Schema Location	http://www.mulesoft.org/schema/mule/jira/current/mule-jira.xsd (View Schema)
Schema Version	2.0
Minimum Mule Version	3.2

Module Overview

JIRA is a proprietary issue tracking product, developed by Atlassian, commonly used for bug tracking, issue tracking, and project management.

Summary

Configuration
<jira:config> Configure an instance of this module

Message Processors
<jira:add-actors-to-project-role> Adds the given actors to the project role.
<jira:add-base64-encoded-attachments-to-issue> An alternative mechanism for adding attachments to an issue.
<jira:add-comment> Adds a new comment to the issue.
<jira:add-default-actors-to-project-role> Adds the default actors to the project role denoted by this id.
<jira:add-effort> Add an effort to an issue's worklog
<jira:add-permission-to> Adds the permission to the given entity name (username or group name)
<jira:add-user-to-group> Adds a user to the given group name.
<jira:add-version> Adds a new version
<jira:add-worklog-and-auto-adjust-remaining-estimate> Adds a worklog to the given issue.
<jira:add-worklog-and-retain-remaining-estimate> Adds a worklog to the given issue but leaves the issue's remaining estimate field unchanged.
<jira:add-worklog-with-new-remaining-estimate> Adds a worklog to the given issue and sets the issue's remaining estimate field to the given value.
<jira:archive-version> Archieves the given version/
<jira:create-component> Create a component
<jira:create-group> Creates a group with the given name optionally adding the given user to it.
<jira:create-issue> Creates an issue.
<jira:create-issue-using-object> Creates an issue.
<jira:create-issue-with-parent> Creates a sub-task.
<jira:create-issue-with-security-level> Creates an issue using the the security level denoted by the given id.
<jira:create-permission-scheme> Creates a new permission schema using the given name and description.
<jira:create-project> Creates a new project
<jira:create-project-role> Creates a new project role.
<jira:create-project-using-object> Creates a new project.
<jira:create-user> Creates a user in JIRA with the specified user details
<jira:create-version> Create a version
<jira:delete-group> Deletes the group denoted by the given group name.
<jira:delete-issue> Deletes the issue with the given key
<jira:delete-permission-from> Removes the permission to the given entity name (username or group name)
<jira:delete-permission-scheme> Deletes the permission scheme denoted by the given name
<jira:delete-project> Deletes the project represented by the given project key.
<jira:delete-project-avatar> Deletes the given custom Avatar from the system.
<jira:delete-project-role> Deletes the project role denoted by the given project role id.
<jira:delete-user> Deletes a user in JIRA with the specified username.
<jira:delete-worklog-and-auto-adjust-remaining-estimate> Deletes the worklog with the given id and updates the remaining estimate field on the isssue by increasing it by the time spent amount on the worklog being deleted.
<jira:delete-worklog-and-retain-remaining-estimate> Deletes the worklog with the given id but leaves the remaining estimate field on the isssue unchanged.
<jira:delete-worklog-with-new-remaining-estimate> Deletes the worklog with the given id and sets the remaining estimate field on the isssue to the given value.
<jira:edit-comment> Edits the comment denoted by the given id
<jira:get-all-permissions> Returns all the permissions.
<jira:get-associated-notification-schemes> Returns the associated notification schemes for the given project role.
<jira:get-associated-permission-schemes> Returns the associated permission schemas for the given project role.
<jira:get-attachments-from-issue> Returns the attachments for the issue denoted by the given key.
<jira:get-available-actions> Finds the available actions for the given issue key
<jira:get-comment> Finds a comment.
<jira:get-comments> Returns the comments for the issue denoted by the given key.
<jira:get-components> Returns an array of all the components for the specified project key.
<jira:get-configuration> Returns information about the current configuration of JIRA.
<jira:get-custom-fields> Returns the custom fields for the current user
<jira:get-default-role-actors> Returns the default role actors for the given project role id.
<jira:get-favourite-filters> This retreives a list of the currently logged in user's favourite fitlers.
<jira:get-fields-for-action> Returns the fields for the given action.
<jira:get-fields-for-edit> Returns the fields for edit for the given issue key
<jira:get-group> Find the group with the specified name in JIRA.
<jira:get-issue> Get an issue given its key
<jira:get-issue-by-id> Returns the issue for the given issue id.
<jira:get-issue-count-for-filter> Returns the issue count for the filter denoted by this id.
<jira:get-issue-types> Returns an array of all the issue types for all projects in JIRA.
<jira:get-issue-types-for-project> Returns an array of all the (non-sub task) issue types for the specified project id.
<jira:get-issues-from-filter-with-limit> Returns issues that match the saved filter specified by the filterId.
<jira:get-issues-from-jql-search> Execute a specified JQL query and return the resulting issues.
<jira:get-issues-from-text-search-with-limit> Returns issues containing searchTerms.
<jira:get-issues-from-text-search-with-project> Returns issues containing searchTerms that are within the specified projects.
<jira:get-notification-schemes> Returns notification schemes.
<jira:get-permission-schemes> Returns the permission schemes.
<jira:get-priorities> Returns an array of all the issue statuses in JIRA.
<jira:get-project> Get a project given its key
<jira:get-project-avatar> Retrieves the current avatar for the given project.
<jira:get-project-avatars> Retrieves avatars for the given project.
<jira:get-project-by-id> Returns the Project with the matching id (if the user has permission to browse it).
<jira:get-project-by-key> Returns the Project with the matching key (if the user has permission to browse it).
<jira:get-project-role> Returns the project role by projectRoleId.
<jira:get-project-role-actors> Returns the project role actors for the given project
<jira:get-project-roles> Returns the project roles.
<jira:get-project-with-schemes-by-id> Returns the Project with the matching id (if the user has permission to browse it) with notification, issue security and permission schemes attached.
<jira:get-projects-no-schemes> Returns an array of all the Projects defined in JIRA.
<jira:get-remote-issue> Finds an issue by key.
<jira:get-remote-user> Returns information about a user defined to JIRA.
<jira:get-resolution-date-by-id> Given an issue id, this method returns the resolution date for this issue.
<jira:get-resolution-date-by-key> Given an issue key, this method returns the resolution date for this issue.
<jira:get-resolutions> Returns an array of all the issue resolutions in JIRA.
<jira:get-security-level> Returns the current security level for given issue
<jira:get-security-levels> Returns an array of all security levels for a given project.
<jira:get-security-schemes> Returns the security schemes.
<jira:get-server-info> Returns information about the server JIRA is running on including build number and base URL.
<jira:get-statuses> Returns an array of all the issue statuses in JIRA.
<jira:get-sub-task-issue-types> Returns an array of all the sub task issue types in JIRA.
<jira:get-sub-task-issue-types-for-project> Returns an array of all the sub task issue types for the specified project id.
<jira:get-user> Get a user given its username
<jira:get-versions> Returns an array of all the versions for the specified project key.
<jira:get-worklogs> Returns all worklogs for the given issue.
<jira:has-permission-to-create-worklog> Determines if the user has the permission to add worklogs to the specified issue, that timetracking is enabled in JIRA and that the specified issue is in an editable workflow state.
<jira:has-permission-to-delete-worklog> Determine whether the current user has the permission to delete the supplied worklog, that timetracking is enabled in JIRA and that the associated issue is in an editable workflow state.
<jira:has-permission-to-edit-comment> Returns whether the current user has permissions to edit the comment denoted by the given id.
<jira:has-permission-to-update-worklog> Determine whether the current user has the permission to update the supplied worklog, that timetracking is enabled in JIRA and that the associated issue is in an editable workflow state.
<jira:is-project-role-name-unique> Checks if the given project role name is unique.
<jira:login> Log in using the given credentials, it returns the authentication token.
<jira:logout> Cleans up an authentication token that was previously created with a call to login
<jira:progress-workflow-action> This will progress an issue through a workflow.
<jira:refresh-custom-fields> Refreshs custom fields for the current user.
<jira:release-version> Releases the version denoted by the given name
<jira:remove-actors-from-project-role> Removes the given actors from the project role
<jira:remove-all-role-actors-by-name-and-type> Removes all role actors using the given name and type.
<jira:remove-all-role-actors-by-project> Removes all role actors for the given project key.
<jira:remove-default-actors-from-project-role> Removes the default actors from the project role denoted by this id.
<jira:remove-user-from-group> Removes a user from the group name.
<jira:set-new-project-avatar> Creates a new custom avatar for the given project and sets it to be current for the project.
<jira:set-project-avatar> Sets the current avatar for the given project to that with the given id.
<jira:update-component> Update a component
<jira:update-group> Updates the given group name with the provided users.
<jira:update-issue> This will update an issue with new values.
<jira:update-issues-by-jql> This will update the set of issues that result from the jql search NOTE : You cannot update the 'status' field of the issues via this method.
<jira:update-project> Updates the project denoted by the given key.
<jira:update-project-role> Updates the project role with the given id.
<jira:update-version> Update a version
<jira:update-worklog-with-new-remaining-estimate> Modifies the worklog with the id of the given worklog, updating its fields to match the given worklog and sets the remaining estimate field on the relevant issue to the given value.
<jira:upload-attachment> Upload an attachment to the issue

Configuration

To use the this module within a flow the namespace to the module must be included. The resulting flow will look similar to the following:

<mule xmlns="http://www.mulesoft.org/schema/mule/core"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xmlns:jira="http://www.mulesoft.org/schema/mule/jira"
      xsi:schemaLocation="
               http://www.mulesoft.org/schema/mule/core
               http://www.mulesoft.org/schema/mule/core/current/mule.xsd
               http://www.mulesoft.org/schema/mule/jira
               http://www.mulesoft.org/schema/mule/jira/current/mule-jira.xsd">

      <!-- here goes your flows and configuration elements -->

</mule>

This module is configured using the config element. This element must be placed outside of your flows and at the root of your Mule application. You can create as many configurations as you deem necessary as long as each carries its own name.

Each message processor, message source or transformer carries a config-ref attribute that allows the invoker to specify which configuration to use.

Attributes
Type	Name	Default Value	Description	Java Type	MIME Type	Encoding
xs:string	name		Optional. Give a name to this configuration so it can be later referenced.
xs:boolean	useCustomFieldsExternalName	false	Optional. if external custom fields names (instead of internal ids) are used when modifying custom fields, the provided user must be a Jira administrator in order to be able to use this feature

Connection Pool

This connector offers automatic connection management via the use of a connection pool. The pool will act a storage mechanism for all the connections that are in-use by the user of this connector.

Prior to execution of a processor, the connector will attempt to lookup an already established connection and if one doesn't exists it will create one. That lookup mechanism is done in the connection pool via the use of connection variables declared as keys.

The user of the connector can configure the pool by adding a connection-pooling-profile to the connector configuration like this:

    <jira:connection-pooling-profile maxActive="10" maxIdle="10"
                             exhaustedAction="WHEN_EXHAUSTED_GROW" maxWait="120" minEvictionMillis="60000" evictionCheckIntervalMillis="30000"/>

The following is a list of connection attributes, each connection attribute can be configured at the config element level or they can also be added to each processor. If they are used at the processor level they get the benefit of full expression resolution.

Connection Attributes
Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
connectionUser		The user login user	String	/	UTF-8
connectionPassword		The user login pass	String	/	UTF-8
connectionAddress		The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl		Optional. The JIRA REST API URI	String	/	UTF-8

Reconnection Strategies

Reconnection Strategies specify how a connector behaves when its connection fails. You can control how Mule attempts to reconnect by specifying a number of criteria:

The type of exception
Number and frequency of reconnection attempts
The notifications generated, and more

With a reconnection strategy, you can better control the behavior of a failed connection, by configuring it, for example, to re-attempt the connection only once every 15 minutes, and to give up after 30 attempts. You can also send an automatic notification to your IT administrator whenever this reconnection strategy goes into effect. You can even define a strategy that attempts to reconnect only during business hours. Such a setting can prove useful if your server is frequently shut down for nightly maintenance.

Configuration

A reconnection strategy that allows the user to configure how many times a reconnection should be attempted and how long to wait between attempts.

    <jira:config>
         <reconnect count="5" frequency="1000"/>
    </jira:config>

Reconnect Attributes
Name	Default Value	Description
frequency	2000	Optional. How often (in ms) to reconnect
count	2	Optional. How many reconnection attempts to make

For more information about reconnection strategies in Mule, or even how to write your own custom reconnection strategy please check this section.

Message Processors

<jira:add-actors-to-project-role>

Adds the given actors to the project role.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
projectRoleId	The id of the project role to use	Long	/
projectKey	The key of project to use	String	/	UTF-8
actorType	Optional. The actor type to use	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<jira:actors>		The actors to add	List<String>

<jira:add-base64-encoded-attachments-to-issue>

An alternative mechanism for adding attachments to an issue. This method accepts the data of the attachments as Base64 encoded strings instead of byte arrays. This is to combat the XML message bloat created by Axis when SOAP-ifying byte arrays. For more information, please see JRA-11693.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
issueKey	The issue to attach to	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<jira:file-names>		An array of filenames; each element names an attachment to be uploaded	List<String>
<jira:base64-encoded-attachment-data>		An array of Base 64 encoded Strings; each element contains the data of the attachment to be uploaded	List<String>

Returns

Return Type	Description
boolean	true if attachments were successfully added; if the operation was not successful, an exception would be thrown

<jira:add-comment>

Adds a new comment to the issue.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
issueKey	The key of the issue	String	/	UTF-8
commentAuthor	The author of the comment	String	/	UTF-8
commentBody	The body of the comment	String	/	UTF-8
commentGroupLevel	Optional. The group level of the comment	String	/	UTF-8
commentRoleLevel	Optional. The role level of the comment	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
RemoteComment	Added comment

<jira:add-default-actors-to-project-role>

Adds the default actors to the project role denoted by this id.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
projectRoleId	The id of the project role	Long	/
type	Optional. The type	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<jira:actors>		The actors to add	List<String>

<jira:add-effort>

Add an effort to an issue's worklog

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
issue	#[payload]	Optional. In which to add the effort	Issue	/
authorUri		Uri of the author of the effort	String	/	UTF-8
date		In which the effort should be created	DateTime	/
minutes		Spent	int	/
comment		Optional. To add to the effort	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser		Optional. The user login user	String	/	UTF-8
connectionPassword		Optional. The user login pass	String	/	UTF-8
connectionAddress		Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl		Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
Void	nothing

Exception Payloads

Payload Class	Description
URISyntaxException	when the URI is not well formed

<jira:add-permission-to>

Adds the permission to the given entity name (username or group name)

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
permissionSchemeName	The name of the permission scheme to use	String	/	UTF-8
permissionCode	The permission code to use	Long	/
entityName	The entity name, username or group name	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
RemotePermissionScheme	the modified permission scheme

<jira:add-user-to-group>

Adds a user to the given group name.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
groupName	The group name	String	/	UTF-8
userName	The user name	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

<jira:add-version>

Adds a new version

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
projectKey	The project key to use	String	/	UTF-8
versionName	The version name to use	String	/	UTF-8
archived	Whether is archived	Boolean	/
released	Whether is released	Boolean	/
releaseDate	The release date to use in the format MM-dd-yyy'T'HH:mm:ss	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
RemoteVersion	the new version

<jira:add-worklog-and-auto-adjust-remaining-estimate>

Adds a worklog to the given issue.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
issueKey	The key of the issue.	String	/	UTF-8
timeSpent	Specifies a time duration in JIRA duration format, representing the time spent working on the worklog, eg 1d 2h.	String	/	UTF-8
startDate	The start date of the worklog using the format MM-dd-yyy'T'HH:mm:ss	String	/	UTF-8
comment	Optional. Add a comment to the worklog.	String	/	UTF-8
groupLevel	Optional. The new group level.	String	/	UTF-8
roleLevelId	Optional. The new role level id.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
RemoteWorklog	Created worklog with the id set or null if no worklog was created.

<jira:add-worklog-and-retain-remaining-estimate>

Adds a worklog to the given issue but leaves the issue's remaining estimate field unchanged.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
issueKey	The key of the issue.	String	/	UTF-8
timeSpent	Specifies a time duration in JIRA duration format, representing the time spent working on the worklog, eg 1d 2h.	String	/	UTF-8
startDate	The start date of the worklog using the format MM-dd-yyy'T'HH:mm:ss	String	/	UTF-8
comment	Optional. Add a comment to the worklog.	String	/	UTF-8
groupLevel	Optional. The new group level.	String	/	UTF-8
roleLevelId	Optional. The new role level id.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
RemoteWorklog	Created worklog with the id set or null if no worklog was created.

<jira:add-worklog-with-new-remaining-estimate>

Adds a worklog to the given issue and sets the issue's remaining estimate field to the given value.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
issueKey	The key of the issue.	String	/	UTF-8
timeSpent	Specifies a time duration in JIRA duration format, representing the time spent working on the worklog, eg 1d 2h.	String	/	UTF-8
startDate	The start date of the worklog using the format MM-dd-yyy'T'HH:mm:ss	String	/	UTF-8
newRemainingEstimate	Specifies the issue's remaining estimate as a duration string, eg 1d 2h.	String	/	UTF-8
comment	Optional. Add a comment to the worklog.	String	/	UTF-8
groupLevel	Optional. The new group level.	String	/	UTF-8
roleLevelId	Optional. The new role level id.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
RemoteWorklog	Created worklog with the id set or null if no worklog was created.

<jira:archive-version>

Archieves the given version/

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
projectKey	The project key to use	String	/	UTF-8
versionName	The version name to use	String	/	UTF-8
archive	Whether it should be archived	Boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

<jira:create-component>

Create a component

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
projectKey		Of the project for which the Component should be created	String	/	UTF-8
component	#[payload]	Optional. To create	ComponentInput	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser		Optional. The user login user	String	/	UTF-8
connectionPassword		Optional. The user login pass	String	/	UTF-8
connectionAddress		Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl		Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
Component	the created Component

<jira:create-group>

Creates a group with the given name optionally adding the given user to it.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
groupName	The name of the group to create.	String	/	UTF-8
userName	Optional. The user to add to the group (if null, no user will be added).	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
RemoteGroup	the RemoteGroup created

<jira:create-issue>

Creates an issue.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
assignee	Optional. The assignee of the new issue	String	/	UTF-8
summary	The summary of the new issue	String	/	UTF-8
description	Optional. The description of the new issue	String	/	UTF-8
dueDate	Optional. The due date of the new issue using the format MM-dd-yyy'T'HH:mm:ss	String	/	UTF-8
environment	Optional. The environment of the new issue	String	/	UTF-8
priority	Optional. The priority of the new issue	String	/	UTF-8
project	The project of the new issue	String	/	UTF-8
reporter	Optional. The reporter of the new issue	String	/	UTF-8
type	The type of the new issue	String	/	UTF-8
votes	Optional. The votes of the new issue	Long	/
componentName	Optional. The component name	String	/	UTF-8
componentId	Optional. The componentId	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<jira:custom-fields>		Optional. The custom fields of the new issue, the keys of the map are the field ids, the values should be separated by a "\|" if it is multivalued	Map<String, String>

Returns

Return Type	Description
RemoteIssue	the new created issue

<jira:create-issue-using-object>

Creates an issue.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
issue	#[payload]	Optional. JIRA issue to be created	RemoteIssue	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser		Optional. The user login user	String	/	UTF-8
connectionPassword		Optional. The user login pass	String	/	UTF-8
connectionAddress		Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl		Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
RemoteIssue	the new created issue

<jira:create-issue-with-parent>

Creates a sub-task.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
issue	#[payload]	Optional. JIRA issue to be created	RemoteIssue	/
parentIssueKey		JIRA issue to be created	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser		Optional. The user login user	String	/	UTF-8
connectionPassword		Optional. The user login pass	String	/	UTF-8
connectionAddress		Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl		Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
RemoteIssue	the new created issue

<jira:create-issue-with-security-level>

Creates an issue using the the security level denoted by the given id.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
assignee	Optional. The assignee of the new issue	String	/	UTF-8
summary	The summary of the new issue	String	/	UTF-8
description	Optional. The description of the new issue	String	/	UTF-8
dueDate	Optional. The due date of the new issue using the format MM-dd-yyy'T'HH:mm:ss	String	/	UTF-8
environment	Optional. The environment of the new issue	String	/	UTF-8
priority	Optional. The priority of the new issue	String	/	UTF-8
project	The project of the new issue	String	/	UTF-8
reporter	Optional. The reporter of the new issue	String	/	UTF-8
type	The type of the new issue	String	/	UTF-8
votes	Optional. The votes of the new issue	Long	/
securityLevelId	The id of the security level to use	Long	/
componentName	Optional. The component name	String	/	UTF-8
componentId	Optional. The componentId	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<jira:custom-fields>		Optional. The custom fields of the new issue, the keys of the map are the field ids, the values should be separated by a "\|" if it is multivalued	Map<String, String>

Returns

Return Type	Description
RemoteIssue	the new created issue

<jira:create-permission-scheme>

Creates a new permission schema using the given name and description.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
permissionName	The name of the new permission scheme	String	/	UTF-8
description	The description of the new permission scheme	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
RemotePermissionScheme	the created permission scheme

<jira:create-project>

Creates a new project

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
key	The key for the new project	String	/	UTF-8
projectName	The name for the new project	String	/	UTF-8
description	The description for the new project	String	/	UTF-8
url	Optional. The url for the new project	String	/	UTF-8
lead	The lead of the new project	String	/	UTF-8
permissionSchemeName	Optional. The name of the permission scheme for the new project	String	/	UTF-8
notificationSchemeName	Optional. The name of the notification scheme for the new project	String	/	UTF-8
securityShemeName	Optional. The name of the security scheme for the new project	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
RemoteProject	the new project

<jira:create-project-role>

Creates a new project role.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
projectRoleName	The name of the new project role	String	/	UTF-8
projectRoleDescription	The description of the new project role	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
RemoteProjectRole	the created project role

<jira:create-project-using-object>

Creates a new project.

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
project	#[payload]	Optional. JIRA issue to be created	RemoteProject	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser		Optional. The user login user	String	/	UTF-8
connectionPassword		Optional. The user login pass	String	/	UTF-8
connectionAddress		Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl		Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
RemoteProject	the new created project

<jira:create-user>

Creates a user in JIRA with the specified user details

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
username	The user name to create	String	/	UTF-8
password	The password for the new user	String	/	UTF-8
fullName	The full name of the new user	String	/	UTF-8
email	The email of the new user	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
RemoteUser	the newly created RemoteUser

<jira:create-version>

Create a version

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
version	#[payload]	Optional. To create	VersionInput	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser		Optional. The user login user	String	/	UTF-8
connectionPassword		Optional. The user login pass	String	/	UTF-8
connectionAddress		Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl		Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
Version	the created Version

<jira:delete-group>

Deletes the group denoted by the given group name.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
groupName	The group name to use	String	/	UTF-8
swapGroupName	Optional. The swap group name to use	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

<jira:delete-issue>

Deletes the issue with the given key

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
issueKey	The key of the issue to delete	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

<jira:delete-permission-from>

Removes the permission to the given entity name (username or group name)

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
permissionSchemeName	The name of the permission scheme to use	String	/	UTF-8
permissionCode	The permission code to use	Long	/
entityName	The entity name, username or group name	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
RemotePermissionScheme	the modified permission scheme

<jira:delete-permission-scheme>

Deletes the permission scheme denoted by the given name

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
permissionSchemeName	The name of the permission scheme to delete	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

<jira:delete-project>

Deletes the project represented by the given project key.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
projectKey	The key of the project to delete	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

<jira:delete-project-avatar>

Deletes the given custom Avatar from the system. System avatars cannot be deleted. Project administration permission is required.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
avatarId	Id of the custom avatar to delete.	Long	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

<jira:delete-project-role>

Deletes the project role denoted by the given project role id.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
projectRoleId	The id of the project role to delete	Long	/
confirm	Whether confirm	Boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

<jira:delete-user>

Deletes a user in JIRA with the specified username.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
username	The user name to delete	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

<jira:delete-worklog-and-auto-adjust-remaining-estimate>

Deletes the worklog with the given id and updates the remaining estimate field on the isssue by increasing it by the time spent amount on the worklog being deleted. The time spent field of the issue is reduced by the time spent amount on the worklog being deleted.

XML Sample

INCLUDE_ERROR

the SOAP auth token.

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
worklogId	The id of the worklog to delete.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

<jira:delete-worklog-and-retain-remaining-estimate>

Deletes the worklog with the given id but leaves the remaining estimate field on the isssue unchanged. The time spent field of the issue is reduced by the time spent amount on the worklog being deleted.

XML Sample

INCLUDE_ERROR

the SOAP auth token.

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
worklogId	The id of the worklog to delete.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

<jira:delete-worklog-with-new-remaining-estimate>

Deletes the worklog with the given id and sets the remaining estimate field on the isssue to the given value. The time spent field of the issue is reduced by the time spent amount on the worklog being deleted.

XML Sample

INCLUDE_ERROR

the SOAP auth token.

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
workLogId	The id of the worklog to delete.	String	/	UTF-8
newRemainingEstimate	The new value for the issue's remaining estimate as a duration string, eg 1d 2h.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

<jira:edit-comment>

Edits the comment denoted by the given id

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
commentId	The id of the comment to edit	Long	/
body	Optional. The updated body comment	String	/	UTF-8
updateAuthor	Optional. The update author	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
RemoteComment	the edited comment

<jira:get-all-permissions>

Returns all the permissions.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
List<Object>	all the permissions

<jira:get-associated-notification-schemes>

Returns the associated notification schemes for the given project role.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
projectRoleId	The project role to search	Long	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
List<Object>	the associated notification schemes for the given project role.

<jira:get-associated-permission-schemes>

Returns the associated permission schemas for the given project role.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
projectRoleId	The project role to search	Long	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
List<Object>	the associated permission schemas for the given project role.

<jira:get-attachments-from-issue>

Returns the attachments for the issue denoted by the given key.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
issueKey	The issue key to use	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
List<Object>	the attachments for the issue denoted by the given key.

<jira:get-available-actions>

Finds the available actions for the given issue key

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
issueKey	The key of the issue	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
List<Object>	the available actions for the given issue key

<jira:get-comment>

Finds a comment.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
commentId	The commentId of the comment	Long	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
RemoteComment	the RemoteComment

<jira:get-comments>

Returns the comments for the issue denoted by the given key.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
issueKey	The key of the issue to get the comments for	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
List<Object>	the comments for the issue denoted by the given key.

<jira:get-components>

Returns an array of all the components for the specified project key.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
projectKey	The key of the requested project	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
List<Object>	an array of RemoteComponent objects

<jira:get-configuration>

Returns information about the current configuration of JIRA.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
RemoteConfiguration	a RemoteConfiguration object which contains information about the current configuration of JIRA.

<jira:get-custom-fields>

Returns the custom fields for the current user

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
List<Object>	the custom fields for the current user

<jira:get-default-role-actors>

Returns the default role actors for the given project role id.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
projectRoleId	The id of the project role	Long	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
RemoteRoleActors	the default role actors for the given project role id.

<jira:get-favourite-filters>

This retreives a list of the currently logged in user's favourite fitlers.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
List<Object>	a list of the currently logged in user's favourite fitlers.

<jira:get-fields-for-action>

Returns the fields for the given action.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
issueKey	The issue key to use	String	/	UTF-8
actionIdString	The action id to use	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
List<Object>	the fields for the given action

<jira:get-fields-for-edit>

Returns the fields for edit for the given issue key

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
issueKey	The issue key to get the fields for	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
List<Object>	the fields for edit

<jira:get-group>

Find the group with the specified name in JIRA.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
groupName	The name of the group to find	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
RemoteGroup	a RemoteGroup object for the found group or null if it cant be found.

<jira:get-issue>

Get an issue given its key

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
issueKey	The key of the issue to get	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
Issue	the requested Issue

<jira:get-issue-by-id>

Returns the issue for the given issue id.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
issueId	The issue id to use	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
RemoteIssue	the issue for the given issue id.

<jira:get-issue-count-for-filter>

Returns the issue count for the filter denoted by this id.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
filterId	The fiter id to use	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
long	the issue count for the filter denoted by this id.

<jira:get-issue-types>

Returns an array of all the issue types for all projects in JIRA.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
List<Object>	an array of RemoteIssueType objects

<jira:get-issue-types-for-project>

Returns an array of all the (non-sub task) issue types for the specified project id.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
projectId	Id of the project	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
List<Object>	an array of RemoteIssueType objects

<jira:get-issues-from-filter-with-limit>

Returns issues that match the saved filter specified by the filterId. This method will return no more than the maxNumResults.

It will start the result set at the provided off set.

This method also respects the jira.search.views.max.limit and jira.search.views.max.unlimited.group JIRA properties which will override the max number of results returned.

If the jira.search.views.max.limit property is set and you are not in a group specified by jira.search.views.max.unlimited.group then the number of results returned will be constrained by the value of jira.search.views.max.limit if it is less than the specified maxNumResults.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
filterId	Identifies the saved filter to use for the search.	String	/	UTF-8
offset	The place in the result set to use as the first result returned	Integer	/
maxNumResults	The maximum number of results that this method will return.	Integer	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
List<Object>	issues matching the saved filter

<jira:get-issues-from-jql-search>

Execute a specified JQL query and return the resulting issues. This method also respects the jira.search.views.max.limit and jira.search.views.max.unlimited.group JIRA properties which will override the max number of results returned.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
jqlSearch	JQL query string to execute	String	/	UTF-8
maxNumResults	The maximum number of results that this method will return	Integer	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
List<Object>	issues matching the JQL query

<jira:get-issues-from-text-search-with-limit>

Returns issues containing searchTerms. Note: this is a fuzzy search, returned in order of 'relevance', so the results are only generally useful for human consumption.

This method will return no more than the maxNumResults.

It will start the result set at the provided off set.

This method also respects the jira.search.views.max.limit and jira.search.views.max.unlimited.group JIRA properties which will override the max number of results returned.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
searchTerms	Search terms	String	/	UTF-8
offset	The place in the result set to use as the first result returned	Integer	/
maxNumResults	The maximum number of results that this method will return.	Integer	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
List<Object>	issues matching the search terms

<jira:get-issues-from-text-search-with-project>

Returns issues containing searchTerms that are within the specified projects. Note: this is a fuzzy search, returned in order of 'relevance', so the results are only generally useful for human consumption.

This method will return no more than the maxNumResults.

This method also respects the jira.search.views.max.limit and jira.search.views.max.unlimited.group JIRA properties which will override the max number of results returned.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
searchTerms	Earch terms	String	/	UTF-8
maxNumResults	The maximum number of results that this method will return.	Integer	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<jira:project-keys>		The project keys to use	List<String>

Returns

Return Type	Description
List<Object>	issues matching the search terms

<jira:get-notification-schemes>

Returns notification schemes.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
List<Object>	the notification schemes.

<jira:get-permission-schemes>

Returns the permission schemes.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
List<Object>	the permission schemes.

<jira:get-priorities>

Returns an array of all the issue statuses in JIRA.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
List<Object>	an array of RemoteStatus objects

<jira:get-project>

Get a project given its key

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
projectKey	The key of the project to get	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
Project	the requested Project

<jira:get-project-avatar>

Retrieves the current avatar for the given project. Project browse permission is required.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
projectKey	The key for the project.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
RemoteAvatar	the current avatar for the project.

<jira:get-project-avatars>

Retrieves avatars for the given project. If the includeSystemAvatars parameter is true, this will include both system (built-in) avatars as well as custom (user-supplied) avatars for that project, otherwise it will include only the custom avatars. Project browse permission is required.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
projectKey	The key for the project.	String	/	UTF-8
includeSystemAvatars	If false, only custom avatars will be included in the returned array.	Boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
List<Object>	the avatars for the project, possibly empty.

<jira:get-project-by-id>

Returns the Project with the matching id (if the user has permission to browse it).

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
projectId	The id of the requested project	Long	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
RemoteProject	the RemoteProject object specified by the key, if it exists and the user has the BROWSE permission for it

<jira:get-project-by-key>

Returns the Project with the matching key (if the user has permission to browse it).

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
projectKey	The key of the requested projec	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
RemoteProject	the RemoteProject object specified by the key, if it exists and the user has the BROWSE permission for it

<jira:get-project-role>

Returns the project role by projectRoleId.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
projectRoleId	The projectRoleId of the project role	Long	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
RemoteProjectRole	the project role by projectRoleId.

<jira:get-project-role-actors>

Returns the project role actors for the given project

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
projectRoleId	The project role id to use	Long	/
projectKey	The project key to use	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
RemoteProjectRoleActors	the project role actors for the given project

<jira:get-project-roles>

Returns the project roles.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
List<Object>	the project roles.

<jira:get-project-with-schemes-by-id>

Returns the Project with the matching id (if the user has permission to browse it) with notification, issue security and permission schemes attached.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
projectId	The id of the requested project	Long	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
RemoteProject	the RemoteProject object specified by the key, if it exists and the user has the BROWSE permission for it

<jira:get-projects-no-schemes>

Returns an array of all the Projects defined in JIRA.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
List<Object>	an array of RemoteProject objects.

<jira:get-remote-issue>

Finds an issue by key. This operation is deprecated, instead use @{link getIssue()}

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
issueKey	The key of the issue to find.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
RemoteIssue	the issue matching the given key.

<jira:get-remote-user>

Returns information about a user defined to JIRA. Deprecated by getUser(), which uses the REST API

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
username	The user name to look up	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
RemoteUser	a RemoteUser or null if it cant be found

<jira:get-resolution-date-by-id>

Given an issue id, this method returns the resolution date for this issue. If the issue hasn't been resolved yet, this method will return null. If the no issue with the given id exists a RemoteException will be thrown.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
issueId	The id of the issue	Long	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
Calendar	The resolution date of the issue. May be null

<jira:get-resolution-date-by-key>

Given an issue key, this method returns the resolution date for this issue. If the issue hasn't been resolved yet, this method will return null.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
issueKey	The key of the issue	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
Calendar	The resolution date of the issue. May be null

<jira:get-resolutions>

Returns an array of all the issue resolutions in JIRA.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
List<Object>	an array of RemoteResolution objects

<jira:get-security-level>

Returns the current security level for given issue

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
issueKey	The issue key	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
RemoteSecurityLevel	issue security level

<jira:get-security-levels>

Returns an array of all security levels for a given project.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
projectKey	The key for the project	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
List<Object>	array of RemoteSecurityLevels for the project

<jira:get-security-schemes>

Returns the security schemes.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
List<Object>	the security schemes.

<jira:get-server-info>

Returns information about the server JIRA is running on including build number and base URL.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
RemoteServerInfo	information about the server JIRA is running on including build number and base URL.

<jira:get-statuses>

Returns an array of all the issue statuses in JIRA.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
List<Object>	an array of RemoteStatus objects

<jira:get-sub-task-issue-types>

Returns an array of all the sub task issue types in JIRA.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
List<Object>	an array of RemoteIssueType objects

<jira:get-sub-task-issue-types-for-project>

Returns an array of all the sub task issue types for the specified project id.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
projectId	Id of the project	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
List<Object>	an array of RemoteIssueType objects

<jira:get-user>

Get a user given its username

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
userName	Of the user to get	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
BasicUser	the requested User

<jira:get-versions>

Returns an array of all the versions for the specified project key.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
projectKey	The key of the requested project	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
List<Object>	an array of RemoteVersion objects

<jira:get-worklogs>

Returns all worklogs for the given issue.

XML Sample

INCLUDE_ERROR

the SOAP auth token.

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
issueKey	The key of the issue.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
List<Object>	all the worklogs of the issue.

<jira:has-permission-to-create-worklog>

Determines if the user has the permission to add worklogs to the specified issue, that timetracking is enabled in JIRA and that the specified issue is in an editable workflow state.

XML Sample

INCLUDE_ERROR

the SOAP auth token.

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
issueKey	The key of the issue.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
boolean	true if the user has permission to create a worklog on the specified issue, false otherwise

<jira:has-permission-to-delete-worklog>

Determine whether the current user has the permission to delete the supplied worklog, that timetracking is enabled in JIRA and that the associated issue is in an editable workflow state. This method will return true if the user is a member of the worklog's group/role level (if specified) AND The user has the WORKLOG_DELETE_ALL permission; OR The user is the worklog author and has the WORKLOG_DELETE_OWN permission and false otherwise.

XML Sample

INCLUDE_ERROR

the SOAP auth token.

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
worklogId	The id of the worklog wishes to delete.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
boolean	true if the user has permission to delete the supplied worklog, false otherwise

<jira:has-permission-to-edit-comment>

Returns whether the current user has permissions to edit the comment denoted by the given id.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
commentId	The comment id to use	Long	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
boolean	whether the current user has permissions to edit the comment denoted by the given id.

<jira:has-permission-to-update-worklog>

Determine whether the current user has the permission to update the supplied worklog, that timetracking is enabled in JIRA and that the associated issue is in an editable workflow state. This method will return true if the user is a member of the worklog's group/role level (if specified) AND The user has the WORKLOG_EDIT_ALL permission; OR The user is the worklog author and has the WORKLOG_EDIT_OWN permission and false otherwise.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
worklogId	The ide of the worklog wishes to update.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
boolean	true if the user has permission to update the supplied worklog, false otherwise

<jira:is-project-role-name-unique>

Checks if the given project role name is unique.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
roleName	The project role name to check for uniqueness	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
boolean	true if the given project role name is unique, false otherwise.

<jira:login>

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
username	The username to use	String	/	UTF-8
password	The password to use	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
String	the authentication token

<jira:logout>

Cleans up an authentication token that was previously created with a call to login

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
token	The token to invalidate	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
boolean	true if the logout succeeded

<jira:progress-workflow-action>

This will progress an issue through a workflow.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
issueKey	The issue to update.	String	/	UTF-8
actionIdString	The workflow action to progress to	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<jira:fields>		Optional. The fields to be updated, the key of the map is the field id and the value is a list of values for that field, the values should be separated by a "\|" if it is multivalued	Map<String, String>

Returns

Return Type	Description
RemoteIssue	the updated RemoteIssue

<jira:refresh-custom-fields>

Refreshs custom fields for the current user.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

<jira:release-version>

Releases the version denoted by the given name

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
projectKey	The project key to use	String	/	UTF-8
versionName	The version name to release	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

<jira:remove-actors-from-project-role>

Removes the given actors from the project role

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
projectRoleId	The id of the project role to use	Long	/
projectKey	The key of project to use	String	/	UTF-8
actorType	Optional. The actor type to use	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<jira:actors>		The actors to remove	List<String>

<jira:remove-all-role-actors-by-name-and-type>

Removes all role actors using the given name and type.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
roleName	The name to delete	String	/	UTF-8
type	The type to delete	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

<jira:remove-all-role-actors-by-project>

Removes all role actors for the given project key.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
projectKey	The project key for which to remove all role actors	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

<jira:remove-default-actors-from-project-role>

Removes the default actors from the project role denoted by this id.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
remoteProjectRoleId	The id of the project role	Long	/
type	Optional. The type	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<jira:actors>		The actors to remove	List<String>

<jira:remove-user-from-group>

Removes a user from the group name.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
groupName	The group name for which to remove the user	String	/	UTF-8
userName	The username to remove	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

<jira:set-new-project-avatar>

Creates a new custom avatar for the given project and sets it to be current for the project. The image data must be provided as base64 encoded data and should be 48 pixels square. If the image is larger, the top left 48 pixels are taken, if it is smaller it is upscaled to 48 pixels. The small version of the avatar image (16 pixels) is generated automatically. Project administration permission is required.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
projectKey	The key for the project.	String	/	UTF-8
contentType	The MIME type of the image provided, e.g. image/gif, image/jpeg, image/png.	String	/	UTF-8
base64ImageData	A base 64 encoded image, 48 pixels square.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

<jira:set-project-avatar>

Sets the current avatar for the given project to that with the given id. Project administration permission is required.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
projectKey	The key for the project.	String	/	UTF-8
avatarId	The id of an existing avatar to use for the project or null for the default avatar.	Long	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

<jira:update-component>

Update a component

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
uri		Of the Component to update	String	/	UTF-8
component	#[payload]	Optional. With the updates to be applied	ComponentInput	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser		Optional. The user login user	String	/	UTF-8
connectionPassword		Optional. The user login pass	String	/	UTF-8
connectionAddress		Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl		Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
Component	the updated Component

Exception Payloads

Payload Class	Description
URISyntaxException	when the URI is not well formed

<jira:update-group>

Updates the given group name with the provided users.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
groupName	The group name to update	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<jira:usernames>		The updated usernames	List<String>

Returns

Return Type	Description
RemoteGroup	the updated group

<jira:update-issue>

This will update an issue with new values. NOTE : You cannot update the 'status' field of the issue via this method.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
issueKey	The issue to update.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<jira:fields>		The fields to be updated, the key of the map is the field id and the value is a list of values for that field, the values should be separated by a "\|" if it is multivalued	Map<String, String>

Returns

Return Type	Description
RemoteIssue	the updated RemoteIssue

<jira:update-issues-by-jql>

This will update the set of issues that result from the jql search NOTE : You cannot update the 'status' field of the issues via this method.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
jql	The jql to search the issues that will be updated if issueKey is not set.	String	/	UTF-8
maxRecordsToUpdate	Optional. The number of issues you expect the jql search will find. If set, the update will only take place if the number of issues found is the same as this	Integer	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Child Elements

Name	Default Value	Description	Java Type
<jira:fields>		The fields to be updated, the key of the map is the field id and the value is a list of values for that field, the values should be separated by a "\|" if it is multivalued	Map<String, String>

Returns

Return Type	Description
List<RemoteIssue>	A List with the updated `RemoteIssue`s

<jira:update-project>

Updates the project denoted by the given key.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
key	The key of the project to update	String	/	UTF-8
projectName	Optional. The new project name	String	/	UTF-8
description	The new description	String	/	UTF-8
url	Optional. The new url	String	/	UTF-8
lead	The new lead	String	/	UTF-8
permissionSchemeName	Optional. The new permission scheme name	String	/	UTF-8
notificationSchemeName	Optional. The new notification scheme name	String	/	UTF-8
securityShemeName	Optional. The new security scheme name	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
RemoteProject	the updated project

<jira:update-project-role>

Updates the project role with the given id.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
projectRoleId	The id of the project role to update	Long	/
projectRoleName	Optional. The new project role name	String	/	UTF-8
projectRoleDescription	Optional. The new project role description	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

<jira:update-version>

Update a version

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
uri		Of the Version to update	String	/	UTF-8
version	#[payload]	Optional. With the updates to be applied	VersionInput	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser		Optional. The user login user	String	/	UTF-8
connectionPassword		Optional. The user login pass	String	/	UTF-8
connectionAddress		Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl		Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
Version	the updated Version

Exception Payloads

Payload Class	Description
URISyntaxException	when the URI is not well formed

<jira:update-worklog-with-new-remaining-estimate>

Modifies the worklog with the id of the given worklog, updating its fields to match the given worklog and sets the remaining estimate field on the relevant issue to the given value. The time spent field of the issue is changed by subtracting the previous value of the worklog's time spent amount and adding the new value in the given worklog.

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
issueKey	The issue key to use	String	/	UTF-8
worklogId	The worklog id to use	String	/	UTF-8
newRemainingEstimate	The new value for the issue's remaining estimate as a duration string, eg 1d 2h.	String	/	UTF-8
comment	Optional. The new comment	String	/	UTF-8
groupLevel	Optional. The new group level	String	/	UTF-8
roleLevelId	Optional. The new role level id	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser	Optional. The user login user	String	/	UTF-8
connectionPassword	Optional. The user login pass	String	/	UTF-8
connectionAddress	Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl	Optional. The JIRA REST API URI	String	/	UTF-8

<jira:upload-attachment>

Upload an attachment to the issue

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
issue	#[payload]	Optional. In which to upload the attachment to	Issue	/
in		InputStream of the file's content	InputStream	/
filename		Of the attachment	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
connectionUser		Optional. The user login user	String	/	UTF-8
connectionPassword		Optional. The user login pass	String	/	UTF-8
connectionAddress		Optional. The JIRA Server Soap address. It usually looks like https://<jira server hostname>/rpc/soap/jirasoapservice-v2 or http://<jira server hostname>/rpc/soap/jirasoapservice-v2	String	/	UTF-8
restJiraUrl		Optional. The JIRA REST API URI	String	/	UTF-8

Returns

Return Type	Description
Void	nothing