Summary: Configuration | Message Processors

org.mule.modules

mule-module-jira

2.1-SNPASHOT

Namespace	http://repository.mulesoft.org/releases/org/mule/modules/mule-module-jira
Schema Location	http://repository.mulesoft.org/releases/org/mule/modules/mule-module-jira/2.0/mule-jira.xsd
Version	1.0
Minimum Mule Version	3.2

Module Overview

Cloud Connector Facade to Jira Tracker

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-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:archive-version> Archieves the given version/
<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-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-user> Creates a user in JIRA with the specified user details
<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> Finds an issue by 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-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-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> Returns information about a user defined to JIRA.
<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-group> Updates the given group name with the provided users.
<jira:update-issue> This will update an issue with new values.
<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-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.

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://repository.mulesoft.org/releases/org/mule/modules/mule-module-jira"
      xsi:schemaLocation="
               http://www.mulesoft.org/schema/mule/core
               http://www.mulesoft.org/schema/mule/core/current/mule.xsd
               http://repository.mulesoft.org/releases/org/mule/modules/mule-module-jira
               http://repository.mulesoft.org/releases/org/mule/modules/mule-module-jira/2.0/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 necesary 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
xs:string	name		Optional. Give a name to this configuration so it can be later referenced.
xs:string	address		The JIRA Server Soap address.
xs:string	password		The user login password
xs:string	username		The user login username

Message Processors

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

Adds the given actors to the project role.

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
actors		the actors to add
projectRoleId		the id of the project role to use
projectKey		the key of project to use
actorType		Optional. the actor type to use

Child Elements

<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

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
issueKey		the issue to attach to
fileNames		an array of filenames; each element names an attachment to be uploaded
base64EncodedAttachmentData		an array of Base 64 encoded Strings; each element contains the data of the attachment to be uploaded

Child Elements

Return Payload

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

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
issueKey		the key of the issue
commentAuthor		the author of the comment
commentBody		the body of the comment
commentGroupLevel		Optional. the group level of the comment
commentRoleLevel		Optional. the role level of the comment

Child Elements

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

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

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
actors		the actors to add
projectRoleId		the id of the project role
type		Optional. the type

Child Elements

<jira:add-permission-to>

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

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
permissionSchemeName		the name of the permission scheme to use
permissionCode		the permission code to use
entityName		the entity name, username or group name

Child Elements

Return Payload

the modified permission scheme

<jira:add-user-to-group>

Adds a user to the given group name.

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
groupName		the group name
userName		the user name

Child Elements

<jira:add-version>

Adds a new version

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
projectKey		the project key to use
versionName		the version name to use
archived		whether is archived
released		whether is released
releaseDate		the release date to use in the format MM-dd-yyy'T'HH:mm:ss

Child Elements

Return Payload

the new version

<jira:archive-version>

Archieves the given version/

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
projectKey		the project key to use
versionName		the version name to use
archive		whether it should be archived

Child Elements

<jira:create-group>

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

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
groupName		the name of the group to create.
userName		Optional. the user to add to the group (if null, no user will be added).

Child Elements

Return Payload

the RemoteGroup created

<jira:create-issue>

Creates an issue.

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
assignee		Optional. the assignee of the new issue
summary		the summary of the new issue
description		Optional. the description of the new issue
dueDate		Optional. the due date of the new issue using the format MM-dd-yyy'T'HH:mm:ss
environment		Optional. the environment of the new issue
priority		Optional. the priority of the new issue
project		the project of the new issue
reporter		Optional. the reporter of the new issue
type		the type of the new issue
votes		Optional. the votes of the new issue
customFieldKeys		Optional. the custom field keys of the new issue (must contain same number of elements as custom field values array)
customFieldValues		Optional. the custome field values (must contain same number of elements as custom field keys array)

Child Elements

Return Payload

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

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
assignee		Optional. the assignee of the new issue
summary		the summary of the new issue
description		Optional. the description of the new issue
dueDate		Optional. the due date of the new issue using the format MM-dd-yyy'T'HH:mm:ss
environment		Optional. the environment of the new issue
priority		Optional. the priority of the new issue
project		the project of the new issue
reporter		Optional. the reporter of the new issue
type		the type of the new issue
votes		Optional. the votes of the new issue
customFieldKeys		Optional. the custom field keys of the new issue (must contain same number of elements as custom field values array)
customFieldValues		Optional. the custome field values (must contain same number of elements as custom field keys array)
securityLevelId		the id of the security level to use

Child Elements

Return Payload

the new created issue

<jira:create-permission-scheme>

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

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
name		the name of the new permission scheme
description		the description of the new permission scheme

Child Elements

Return Payload

the created permission scheme

<jira:create-project>

Creates a new project

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
key		the key for the new project
name		the name for the new project
description		the description for the new project
url		Optional. the url for the new project
lead		the lead of the new project
permissionSchemeName		Optional. the name of the permission scheme for the new project
notificationSchemeName		Optional. the name of the notification scheme for the new project
securityShemeName		Optional. the name of the security scheme for the new project

Child Elements

Return Payload

the new project

<jira:create-project-role>

Creates a new project role.

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
projectRoleName		the name of the new project role
projectRoleDescription		the description of the new project role

Child Elements

Return Payload

the created project role

<jira:create-user>

Creates a user in JIRA with the specified user details

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
username		the user name to create
password		the password for the new user
fullName		the full name of the new user
email		the email of the new user

Child Elements

Return Payload

the newly created RemoteUser

<jira:delete-group>

Deletes the group denoted by the given group name.

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
groupName		the group name to use
swapGroupName		Optional. the swap group name to use

Child Elements

<jira:delete-issue>

Deletes the issue with the given key

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
issueKey		the key of the issue to delete

Child Elements

<jira:delete-permission-from>

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

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
permissionSchemeName		the name of the permission scheme to use
permissionCode		the permission code to use
entityName		the entity name, username or group name

Child Elements

Return Payload

the modified permission scheme

<jira:delete-permission-scheme>

Deletes the permission scheme denoted by the given name

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
permissionSchemeName		the name of the permission scheme to delete

Child Elements

<jira:delete-project>

Deletes the project represented by the given project key.

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
projectKey		the key of the project to delete

Child Elements

<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

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
avatarId		id of the custom avatar to delete.

Child Elements

<jira:delete-project-role>

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

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
projectRoleId		the id of the project role to delete
confirm		whether confirm

Child Elements

<jira:delete-user>

Deletes a user in JIRA with the specified username.

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
username		the user name to delete

Child Elements

<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

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used the SOAP auth token.
worklogId		the id of the worklog to delete.

Child Elements

<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

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used the SOAP auth token.
worklogId		the id of the worklog to delete.

Child Elements

<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

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used the SOAP auth token.
workLogId		the id of the worklog to delete.
newRemainingEstimate		the new value for the issue's remaining estimate as a duration string, eg 1d 2h.

Child Elements

<jira:edit-comment>

Edits the comment denoted by the given id

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
commentId		the id of the comment to edit
body		Optional. the updated body comment
updateAuthor		Optional. the update author

Child Elements

Return Payload

the edited comment

<jira:get-all-permissions>

Returns all the permissions.

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used

Child Elements

Return Payload

all the permissions

<jira:get-associated-notification-schemes>

Returns the associated notification schemes for the given project role.

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
projectRoleId		the project role to search

Child Elements

Return Payload

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

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
projectRoleId		the project role to search

Child Elements

Return Payload

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

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
issueKey		the issue key to use

Child Elements

Return Payload

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

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
issueKey		the key of the issue

Child Elements

Return Payload

the available actions for the given issue key

<jira:get-comment>

Finds a comment.

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
commentId		the commentId of the comment

Child Elements

Return Payload

the RemoteComment

<jira:get-comments>

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

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
issueKey		the key of the issue to get the comments for

Child Elements

Return Payload

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

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
projectKey		the key of the requested project

Child Elements

Return Payload

an array of RemoteComponent objects

<jira:get-configuration>

Returns information about the current configuration of JIRA.

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used

Child Elements

Return Payload

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

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used

Child Elements

Return Payload

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

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
projectRoleId		the id of the project role

Child Elements

Return Payload

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

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used

Child Elements

Return Payload

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

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
issueKey		the issue key to use
actionIdString		the action id to use

Child Elements

Return Payload

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

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
issueKey		the issue key to get the fields for

Child Elements

Return Payload

the fields for edit

<jira:get-group>

Find the group with the specified name in JIRA.

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
groupName		the name of the group to find

Child Elements

Return Payload

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

<jira:get-issue>

Finds an issue by key.

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
issueKey		the key of the issue to find.

Child Elements

Return Payload

the issue matching the given key.

<jira:get-issue-by-id>

Returns the issue for the given issue id.

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
issueId		the issue id to use

Child Elements

Return Payload

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

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
filterId		the fiter id to use

Child Elements

Return Payload

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

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used

Child Elements

Return Payload

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

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
projectId		id of the project

Child Elements

Return Payload

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

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
filterId		identifies the saved filter to use for the search.
offset		the place in the result set to use as the first result returned
maxNumResults		the maximum number of results that this method will return.

Child Elements

Return Payload

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

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
jqlSearch		JQL query string to execute
maxNumResults		the maximum number of results that this method will return

Child Elements

Return Payload

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

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
searchTerms		search terms
offset		the place in the result set to use as the first result returned
maxNumResults		the maximum number of results that this method will return.

Child Elements

Return Payload

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

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
projectKeys		the project keys to use
searchTerms		earch terms
maxNumResults		the maximum number of results that this method will return.

Child Elements

Return Payload

issues matching the search terms

<jira:get-notification-schemes>

Returns notification schemes.

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used

Child Elements

Return Payload

the notification schemes.

<jira:get-permission-schemes>

Returns the permission schemes.

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used

Child Elements

Return Payload

the permission schemes.

<jira:get-priorities>

Returns an array of all the issue statuses in JIRA.

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used

Child Elements

Return Payload

an array of RemoteStatus objects

<jira:get-project-avatar>

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

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
projectKey		the key for the project.

Child Elements

Return Payload

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

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
projectKey		the key for the project.
includeSystemAvatars		if false, only custom avatars will be included in the returned array.

Child Elements

Return Payload

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

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
projectId		the id of the requested project

Child Elements

Return Payload

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

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
projectKey		the key of the requested projec

Child Elements

Return Payload

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

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
projectRoleId		the projectRoleId of the project role

Child Elements

Return Payload

the project role by projectRoleId.

<jira:get-project-role-actors>

Returns the project role actors for the given project

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
projectRoleId		the project role id to use
projectKey		the project key to use

Child Elements

Return Payload

the project role actors for the given project

<jira:get-project-roles>

Returns the project roles.

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used

Child Elements

Return Payload

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

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
projectId		the id of the requested project

Child Elements

Return Payload

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

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used

Child Elements

Return Payload

an array of RemoteProject objects.

<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

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
issueId		the id of the issue

Child Elements

Return Payload

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

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
issueKey		the key of the issue

Child Elements

Return Payload

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

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used

Child Elements

Return Payload

an array of RemoteResolution objects

<jira:get-security-level>

Returns the current security level for given issue

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
issueKey		the issue key

Child Elements

Return Payload

issue security level

<jira:get-security-levels>

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

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
projectKey		the key for the project

Child Elements

Return Payload

array of RemoteSecurityLevels for the project

<jira:get-security-schemes>

Returns the security schemes.

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used

Child Elements

Return Payload

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

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used

Child Elements

Return Payload

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

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used

Child Elements

Return Payload

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

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used

Child Elements

Return Payload

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

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
projectId		id of the project

Child Elements

Return Payload

an array of RemoteIssueType objects

<jira:get-user>

Returns information about a user defined to JIRA.

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
username		the user name to look up

Child Elements

Return Payload

a RemoteUser or null if it cant be found

<jira:get-versions>

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

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
projectKey		the key of the requested project

Child Elements

Return Payload

an array of RemoteVersion objects

<jira:get-worklogs>

Returns all worklogs for the given issue.

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used the SOAP auth token.
issueKey		the key of the issue.

Child Elements

Return Payload

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

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used the SOAP auth token.
issueKey		the key of the issue.

Child Elements

Return Payload

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

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used the SOAP auth token.
worklogId		the id of the worklog wishes to delete.

Child Elements

Return Payload

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

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
commentId		the comment id to use

Child Elements

Return Payload

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

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
worklogId		the ide of the worklog wishes to update.

Child Elements

Return Payload

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

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
name		the project role name to check for uniqueness

Child Elements

Return Payload

true if the given project role name is unique, false otherwise.

<jira:login>

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
username		the username to use
password		the password to use

Child Elements

Return Payload

the authentication token

<jira:logout>

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

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		the token to invalidate

Child Elements

Return Payload

true if the logout succeeded

<jira:progress-workflow-action>

This will progress an issue through a workflow.

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
issueKey		the issue to update.
actionIdString		the workflow action to progress to
fieldIds		Optional. the ids of the remote fields
fieldsValues		Optional. the values of the remote fields

Child Elements

Return Payload

the updated RemoteIssue

<jira:refresh-custom-fields>

Refreshs custom fields for the current user.

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used

Child Elements

<jira:release-version>

Releases the version denoted by the given name

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
projectKey		the project key to use
versionName		the version name to release

Child Elements

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

Removes the given actors from the project role

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
actors		the actors to remove
projectRoleId		the id of the project role to use
projectKey		the key of project to use
actorType		Optional. the actor type to use

Child Elements

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

Removes all role actors using the given name and type.

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
name		the name to delete
type		the type to delete

Child Elements

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

Removes all role actors for the given project key.

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
projectKey		the project key for which to remove all role actors

Child Elements

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

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

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
actors		the actors to remove
remoteProjectRoleId		the id of the project role
type		Optional. the type

Child Elements

<jira:remove-user-from-group>

Removes a user from the group name.

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
groupName		the group name for which to remove the user
userName		the username to remove

Child Elements

<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

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
projectKey		the key for the project.
contentType		the MIME type of the image provided, e.g. image/gif, image/jpeg, image/png.
base64ImageData		a base 64 encoded image, 48 pixels square.

Child Elements

<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

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
projectKey		the key for the project.
avatarId		the id of an existing avatar to use for the project or null for the default avatar.

Child Elements

<jira:update-group>

Updates the given group name with the provided users.

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
groupName		the group name to update
usernames		the updated usernames

Child Elements

Return Payload

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

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
issueKey		the issue to update.
fieldIds		the ids of the custom fields
fieldValues		the values for each custom field id

Child Elements

Return Payload

the updated RemoteIssue

<jira:update-project>

Updates the project denoted by the given key.

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
key		the key of the project to update
description		the new description
url		Optional. the new url
lead		the new lead
permissionSchemeName		Optional. the new permission scheme name
notificationSchemeName		Optional. the new notification scheme name
securityShemeName		Optional. the new security scheme name

Child Elements

Return Payload

the updated project

<jira:update-project-role>

Updates the project role with the given id.

XML Sample

INCLUDE_ERROR

Attributes

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
projectRoleId		the id of the project role to update
projectRoleName		Optional. the new project role name
projectRoleDescription		Optional. the new project role description

Child Elements

<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

config-ref		Optional. Specify which configuration to use.
token		Optional. optionally provide a token to use, if not provided username and password will be used
issueKey		the issue key to use
worklogId		the worklog id to use
newRemainingEstimate		the new value for the issue's remaining estimate as a duration string, eg 1d 2h.
comment		Optional. the new comment
groupLevel		Optional. the new group level
roleLevelId		Optional. the new role level id