The JIRA Rest Connector functions within a Mule application as a secure opening through which you can access - and act upon - your information in Jira.
Additional Info
Requires Mule Enterprise License |
Yes |
Requires Entitlement |
Yes |
Mule Version |
3.6.0 or higher |
Configs
OAuth 1.0a
<jirarest:oauth-config>
Configuration
Connector configuration strategy providing OAuth 1.0a authorization for Jira.
Created by Adam Lipka.
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
name |
The name of this configuration. With this name can be later referenced. |
x |
||
serverUrl |
x |
|||
consumerKey |
x |
|||
privateKey |
x |
|||
issueKey |
|
|||
tokensObjectStoreName |
tokensObjectStore |
|
||
persistentStore |
boolean |
true |
|
|
tokenTtl |
int |
|
||
maxTokens |
int |
|
||
expirationInterval |
int |
|
||
proxyUri |
|
|||
proxyUsername |
|
|||
proxyPassword |
|
Basic Authentication
<jirarest:basic-config>
Connection Management
Connector configuration strategy providing HTTP Basic Authentication for Jira.
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
name |
The name of this configuration. With this name can be later referenced. |
x |
||
username |
a username you use to log in into your Jira instance |
x |
||
password |
a password you use to log in into your Jira instance |
x |
||
serverUrl |
an absolute URL of your Jira server |
x |
||
issueKey |
Key of a sample Issue for which metadata will be retrieved, if Datasense is enabled. When omitted, default Issue structure will be used |
|
||
proxyUri |
|
|||
proxyUsername |
|
|||
proxyPassword |
|
Processors
OAuth - Authorize
<jirarest:authorize>
Performs OAuth authorization flow and returns authorization URL.
XML Sample
<jirarest:authorize config-ref="Jirarest"/>
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
OAuth - Unauthorize
<jirarest:unauthorize>
Invalidates stored OAuth access token.
XML Sample
<jirarest:unauthorize config-ref="Jirarest"/>
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
OAuth - Process callback
<jirarest:callback>
Precess Jira OAuth authorization callback, after user has granted access to Jira.
XML Sample
<jirarest:callback config-ref="Jirarest"/>
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
token |
OAuth request token, default from query param |
#[message.inboundProperties.'http.query.params'.oauth_token] |
|
|
verifier |
OAuth verifier, default from query param |
#[message.inboundProperties.'http.query.params'.oauth_verifier] |
|
Generic REST request
<jirarest:generic-rest-request>
Generic rest request
XML Sample
<jirarest:generic-rest-request config-ref="Jirarest" httpMethod="#[flowVars.httpMethod]" url="#[flowVars.url]" />
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
httpMethod |
The Http method which needs to be performed |
x |
||
url |
relative url endpoint of the rest servise |
x |
||
body |
input body of the method |
|
Returns
Return Java Type | Description |
---|---|
REST response body of type Map<String, Object> or List<Map<String, Object>> |
Myself - get logged user
<jirarest:myself>
Get info about currently logged user
XML Sample
<jirarest:myself config-ref="Jirarest"/>
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
Attachments - Add
<jirarest:attachments-add>
Adds attachment to the issue
XML Sample
<jirarest:attachments-add config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]" filename="#[flowVars.filename]" />
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
issueKeyOrId |
The id or key of the issue to add the attachment to |
x |
||
attachmentInputStream |
stream to upload |
#[payload] |
|
|
filename |
file name of the uploaded attachment |
x |
Attachments - Get
<jirarest:attachments-get>
Retrieves the content of given attachment.
XML Sample
<jirarest:attachments-get config-ref="Jirarest" attachmentLink="#[flowVars.attachmentLink]" />
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
attachmentLink |
URL of the attachment |
x |
Returns
Return Java Type | Description |
---|---|
stream of the attachment, caller is responsible for closing the stream |
Attachments - Get all from issue
<jirarest:attachments-get-all-from-issue>
Retrieves attachments from given issue.
XML Sample
<jirarest:attachments-get-all-from-issue config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]" />
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
issueKeyOrId |
The id or key of the issue |
x |
Components - Create
<jirarest:components-create>
DataSense enabled
Creates a new component
XML Sample
<jirarest:components-create config-ref="Jirarest"/>
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
body |
component input map |
#[payload] |
|
Components - Update
<jirarest:components-update>
DataSense enabled
Updates an existing component
XML Sample
<jirarest:components-update config-ref="Jirarest" id="#[flowVars.id]" />
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
id |
id of the component |
x |
||
body |
component input map |
#[payload] |
|
Components - Get
<jirarest:components-get>
Gets a component by Id
XML Sample
<jirarest:components-get config-ref="Jirarest"/>
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
id |
id of the component |
#[payload] |
|
Components - Delete
<jirarest:components-delete>
Deletes a component by Id
XML Sample
<jirarest:components-delete config-ref="Jirarest" id="#[flowVars.id]" />
Groups - Get
<jirarest:groups-get>
Gets a group by group name
XML Sample
<jirarest:groups-get config-ref="Jirarest"/>
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
groupName |
name of the group |
#[payload] |
|
|
expand |
List of fields to expand. Currently only available expand is "users". |
|
Groups - Delete
<jirarest:groups-delete>
Deletes a group by group name
XML Sample
<jirarest:groups-delete config-ref="Jirarest" groupName="#[flowVars.groupName]" />
Groups - Create
<jirarest:groups-create>
DataSense enabled
Creates a new group
XML Sample
<jirarest:groups-create config-ref="Jirarest"/>
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
body |
group input map |
#[payload] |
|
Groups - Add user
<jirarest:groups-add-user>
Adds given user to a group.
XML Sample
<jirarest:groups-add-user config-ref="Jirarest" groupName="#[flowVars.groupName]" user="#[flowVars.user]" />
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
groupName |
name of the requested group |
x |
||
user |
key or name of the user |
x |
Groups - Delete user
<jirarest:groups-delete-user>
Removes given user from a group.
XML Sample
<jirarest:groups-delete-user config-ref="Jirarest" groupName="#[flowVars.groupName]" user="#[flowVars.user]" />
Issues - Create
<jirarest:issues-create>
DataSense enabled
Creates an issue or a sub-task from a input Map
XML Sample
<jirarest:issues-create config-ref="Jirarest"/>
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
body |
issue input map |
#[payload] |
|
Issues - Update
<jirarest:issues-update>
DataSense enabled
Updates an issue with input. The issue can either be updated by setting explicit the field value(s) or by using an operation to change the field value.
XML Sample
<jirarest:issues-update config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]" />
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
issueKeyOrId |
issue key or issue id |
x |
||
body |
issue update input Map |
#[payload] |
|
Issues - Get
<jirarest:issues-get>
Returns a full representation of the issue for the given issue key
XML Sample
<jirarest:issues-get config-ref="Jirarest"/>
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
issueKeyOrId |
issue key or id |
#[payload] |
|
|
fields |
param (which can be specified multiple times) gives a comma-separated list of fields to include in the response. This can be used to retrieve a subset of fields. A particular field can be excluded by prefixing it with a minus. By default, all (*all) fields are returned in this get-issue resource. Note: the default is different when doing a jql search -- the default there is just navigable fields (*navigable). |
|
||
expand |
comma separated list of entities that you want expanded. (worklog, comments, attachments, etc) |
|
Issues - Delete
<jirarest:issues-delete>
Deletes an issue by issue key or id
XML Sample
<jirarest:issues-delete config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]" />
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
issueKeyOrId |
issue key or id |
x |
||
deleteSubtasks |
boolean |
boolean indicating that any subtasks should also be deleted. If the issue has no subtasks this parameter is ignored. If the issue has subtasks and this parameter is missing or false, then the issue will not be deleted and an error will be returned. |
true |
|
Issues - Create bulk
<jirarest:issues-create-bulk>
DataSense enabled
Creates an issues or a sub-tasks from a input Map
XML Sample
<jirarest:issues-create-bulk config-ref="Jirarest"/>
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
body |
issues input map |
#[payload] |
|
Assignee - Set on issue
<jirarest:issues-set-assignee>
DataSense enabled
Sets assignee for requested issue
XML Sample
<jirarest:issues-set-assignee config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]" />
Comments - Get all
<jirarest:comments-get-all>
Gets comments for requested issue
XML Sample
<jirarest:comments-get-all config-ref="Jirarest"/>
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
issueKeyOrId |
issue key or id |
#[payload] |
|
|
expand |
optional flags: renderedBody (provides body rendered in HTML) |
|
Comments - Get
<jirarest:comments-get>
Gets a comment by id
XML Sample
<jirarest:comments-get config-ref="Jirarest" id="#[flowVars.id]" />
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
issueKeyOrId |
issue key or id |
#[payload] |
|
|
id |
comment id |
x |
||
expand |
optional flags: renderedBody (provides body rendered in HTML) |
|
Comments - Add
<jirarest:comments-add>
DataSense enabled
Adds new comment to an issue
XML Sample
<jirarest:comments-add config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]" />
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
issueKeyOrId |
issue key or id |
x |
||
body |
comment create input map |
#[payload] |
|
|
expand |
optional flags: renderedBody (provides body rendered in HTML) |
|
Comments - Update
<jirarest:comments-update>
DataSense enabled
Updates existing comment
XML Sample
<jirarest:comments-update config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]" id="#[flowVars.id]" />
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
issueKeyOrId |
issue key or id |
x |
||
id |
id of the comment |
x |
||
body |
comment update input map |
#[payload] |
|
|
expand |
optional flags: renderedBody (provides body rendered in HTML) |
|
Comments - Delete
<jirarest:comments-delete>
Deletes comment by id
XML Sample
<jirarest:comments-delete config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]" id="#[flowVars.id]" />
Meta - Get
<jirarest:metadata-get>
Returns the meta data for editing an issue. The fields in the editmeta correspond to the fields in the edit screen for the issue. Fields not in the screen will not be in the editemeta.
XML Sample
<jirarest:metadata-get config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]" />
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
issueKeyOrId |
issue key or id |
x |
Notify - Send
<jirarest:issues-notify>
DataSense enabled
Sends a notification (email) to the list or recipients defined in the request.
XML Sample
<jirarest:issues-notify config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]" />
Transitions - Get
<jirarest:transitions-get>
Get a list of the transitions possible for this issue by the current user, along with fields that are required and their types.
XML Sample
<jirarest:transitions-get config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]" />
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
issueKeyOrId |
issue key or id |
x |
||
transitionId |
transition id |
|
Transitions - Do
<jirarest:transitions-perform>
DataSense enabled
Perform a transition on an issue. When performing the transition you can update or set other issue fields.
XML Sample
<jirarest:transitions-perform config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]" />
Remote Links - Get all
<jirarest:remote-links-get-all>
A sub-resource representing the remote issue links on the issue.
XML Sample
<jirarest:remote-links-get-all config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]" />
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
issueKeyOrId |
issue key or id |
x |
||
globalId |
The id of the remote issue link to be returned. If not provided, all remote links for the issue are returned. |
|
Remote Links - Create / Update
<jirarest:remote-links-create>
DataSense enabled
Creates or updates a remote issue link from a input.
XML Sample
<jirarest:remote-links-create config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]" />
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
issueKeyOrId |
issue key or id |
x |
||
body |
remote link input map |
#[payload] |
|
Remote Links - Get
<jirarest:remote-links-get>
Gets a remote link of an Issue by id
XML Sample
<jirarest:remote-links-get config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]" linkId="#[flowVars.linkId]" />
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
issueKeyOrId |
issue key or id |
x |
||
linkId |
remote link id |
x |
Remote Links - Update by linkId
<jirarest:remote-links-update>
DataSense enabled
Updates an existing remote link
XML Sample
<jirarest:remote-links-update config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]" linkId="#[flowVars.linkId]" />
Remote Links - Delete
<jirarest:remote-links-delete>
Deletes a remote link
XML Sample
<jirarest:remote-links-delete config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]" linkId="#[flowVars.linkId]" />
Votes - Get
<jirarest:votes-get>
Get voters of an issue
XML Sample
<jirarest:votes-get config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]" />
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
issueKeyOrId |
issue key or id |
x |
Votes - Add
<jirarest:votes-add>
Cast your vote in favour of an issue.
XML Sample
<jirarest:votes-add config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]" />
Votes - Remove
<jirarest:votes-delete>
Remove your vote from an issue. (i.e. "unvote")
XML Sample
<jirarest:votes-delete config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]" />
Watchers - Get
<jirarest:watchers-get>
Returns the list of watchers for the issue with the given key.
XML Sample
<jirarest:watchers-get config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]" />
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
issueKeyOrId |
issue key or id |
x |
Watchers - Add
<jirarest:watchers-create>
Adds a user to an issue's watcher list.
XML Sample
<jirarest:watchers-create config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]" userName="#[flowVars.userName]" />
Watchers - Remove
<jirarest:watchers-delete>
Removes a user from an issue's watcher list.
XML Sample
<jirarest:watchers-delete config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]" userName="#[flowVars.userName]" />
Worklogs - Get all
<jirarest:worklogs-get-all>
Returns all work logs for an issue.
XML Sample
<jirarest:worklogs-get-all config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]" />
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
issueKeyOrId |
issue key or id |
x |
Worklogs - Add
<jirarest:worklogs-create>
DataSense enabled
Adds a new worklog entry to an issue.
XML Sample
<jirarest:worklogs-create config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]" />
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
issueKeyOrId |
issue key or id |
x |
||
body |
worklog input map |
#[payload] |
|
Worklogs - Get
<jirarest:worklogs-get>
Returns a specific worklog.
XML Sample
<jirarest:worklogs-get config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]" id="#[flowVars.id]" />
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
issueKeyOrId |
issue key or id |
x |
||
id |
worklog id |
x |
Worklogs - Update
<jirarest:worklogs-update>
Updates an existing worklog entry
XML Sample
<jirarest:worklogs-update config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]" id="#[flowVars.id]" />
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
issueKeyOrId |
issue key or id |
x |
||
id |
worklog id |
x |
||
body |
worklog update map |
#[payload] |
|
|
adjustEstimate |
(optional) allows you to provide specific instructions to update the remaining time estimate of the issue. Valid values are "new" - sets the estimate to a specific value "leave"- leaves the estimate as is "auto"- Default option. Will automatically adjust the value based on the new timeSpent specified on the worklog |
|
||
newEstimate |
(required when "new" is selected for adjustEstimate) the new value for the remaining estimate field. |
|
Worklogs - Delete
<jirarest:worklogs-delete>
Deletes specific worklog entry
XML Sample
<jirarest:worklogs-delete config-ref="Jirarest" issueKeyOrId="#[flowVars.issueKeyOrId]" id="#[flowVars.id]" />
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
issueKeyOrId |
issue key or id |
x |
||
id |
worklog id |
x |
||
adjustEstimate |
(optional) allows you to provide specific instructions to update the remaining time estimate of the issue. Valid values are "new" - sets the estimate to a specific value "leave"- leaves the estimate as is "manual" - specify a specific amount to increase remaining estimate by "auto"- Default option. Will automatically adjust the value based on the new timeSpent specified on the worklog |
|
||
newEstimate |
(required when "new" is selected for adjustEstimate) the new value for the remaining estimate field. |
|
||
increaseBy |
(required when "manual" is selected for adjustEstimate) the amount to increase the remaining estimate by e.g. "2d" |
|
Create Meta - Get
<jirarest:create-meta-get>
Returns the meta data for creating issues. This includes the available projects, issue types and fields, including field types and whether or not those fields are required. Projects will not be returned if the user does not have permission to create issues in that project.
XML Sample
<jirarest:create-meta-get config-ref="Jirarest"/>
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
projectIds |
combined with the projectKeys param, lists the projects with which to filter the results. If absent, all projects are returned. This parameter can be specified multiple times, and/or be a comma-separated list. Specifiying a project that does not exist (or that you cannot create issues in) is not an error, but it will not be in the results. |
|
||
projectKeys |
combined with the projectIds param, lists the projects with which to filter the results. If null, all projects are returned. This parameter can be specified multiple times, and/or be a comma-separated list. Specifiying a project that does not exist (or that you cannot create issues in) is not an error, but it will not be in the results. |
|
||
issueTypeIds |
combinded with issuetypeNames, lists the issue types with which to filter the results. If null, all issue types are returned. This parameter can be specified multiple times, and/or be a comma-separated list. Specifiying an issue type that does not exist is not an error. |
|
||
issueTypeNames |
combinded with issuetypeIds, lists the issue types with which to filter the results. If null, all issue types are returned. This parameter can be specified multiple times, but is NOT interpreted as a comma-separated list. Specifiying an issue type that does not exist is not an error. |
|
Issue Links - Create
<jirarest:issue-links-create>
DataSense enabled
Creates an issue link between two issues. The user requires the link issue permission for the issue which will be linked to another issue. The specified link type in the request is used to create the link and will create a link from the first issue to the second issue using the outward description. It also create a link from the second issue to the first issue using the inward description of the issue link type. It will add the supplied comment to the first issue. The comment can have a restriction who can view it. If group is specified, only users of this group can view this comment, if roleLevel is specified only users who have the specified role can view this comment. The user who creates the issue link needs to belong to the specified group or have the specified role.
XML Sample
<jirarest:issue-links-create config-ref="Jirarest"/>
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
body |
issue link create map |
#[payload] |
|
Issue Links - Get
<jirarest:issue-links-get>
Returns an issue link with the specified id.
XML Sample
<jirarest:issue-links-get config-ref="Jirarest" linkId="#[flowVars.linkId]" />
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
linkId |
id of the link |
x |
Issue Links - Delete
<jirarest:issue-links-delete>
Deletes an issue link with the specified id. To be able to delete an issue link you must be able to view both issues and must have the link issue permission for at least one of the issues.
XML Sample
<jirarest:issue-links-delete config-ref="Jirarest" linkId="#[flowVars.linkId]" />
Issue Link Types - Get all
<jirarest:issue-link-types-get-all>
Returns a list of available issue link types, if issue linking is enabled. Each issue link type has an id, a name and a label for the outward and inward link relationship.
XML Sample
<jirarest:issue-link-types-get-all config-ref="Jirarest"/>
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
Issue Link Types - Get
<jirarest:issue-link-types-get>
Returns for a given issue link type id all information about this issue link type.
XML Sample
<jirarest:issue-link-types-get config-ref="Jirarest" issueLinkTypeId="#[flowVars.issueLinkTypeId]" />
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
issueLinkTypeId |
issue link type id |
x |
Issue Link Types - Create
<jirarest:issue-link-types-create>
DataSense enabled
Create a new issue link type.
XML Sample
<jirarest:issue-link-types-create config-ref="Jirarest"/>
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
body |
issue link type input map |
#[payload] |
|
Issue Link Types - Update
<jirarest:issue-link-types-update>
DataSense enabled
Update the specified issue link type.
XML Sample
<jirarest:issue-link-types-update config-ref="Jirarest" issueLinkTypeId="#[flowVars.issueLinkTypeId]" />
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
issueLinkTypeId |
issue link type id |
x |
||
body |
issue link type input map |
#[payload] |
|
Issue Link Types - Delete
<jirarest:issue-link-types-delete>
Delete the specified issue link type.
XML Sample
<jirarest:issue-link-types-delete config-ref="Jirarest" issueLinkTypeId="#[flowVars.issueLinkTypeId]" />
Issue Types - Get all
<jirarest:issue-types-get-all>
Returns a list of all issue types visible to the user
XML Sample
<jirarest:issue-types-get-all config-ref="Jirarest"/>
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
Issue Types - Get
<jirarest:issue-types-get>
Returns a full representation of the issue type that has the given id.
XML Sample
<jirarest:issue-types-get config-ref="Jirarest" id="#[flowVars.id]" />
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
id |
issue type id |
x |
Priorities - Get all
<jirarest:priorities-get-all>
Returns a list of all issue priorities.
XML Sample
<jirarest:priorities-get-all config-ref="Jirarest"/>
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
Priorities - Get
<jirarest:priorities-get>
Returns an issue priority.
XML Sample
<jirarest:priorities-get config-ref="Jirarest" id="#[flowVars.id]" />
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
id |
the id of the priority |
x |
Statuses - Get all
<jirarest:statuses-get-all>
Returns a list of all issue statuses.
XML Sample
<jirarest:statuses-get-all config-ref="Jirarest"/>
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
Statuses - Get
<jirarest:statuses-get>
Returns an issue status.
XML Sample
<jirarest:statuses-get config-ref="Jirarest" idOrName="#[flowVars.idOrName]" />
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
idOrName |
the id of the status |
x |
Projects - Get all
<jirarest:projects-get-all>
Returns all projects which are visible for the currently logged in user. If no user is logged in, it returns the list of projects that are visible when using anonymous access.
XML Sample
<jirarest:projects-get-all config-ref="Jirarest"/>
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
Projects - Get
<jirarest:projects-get>
Gets a full representation of requested project
XML Sample
<jirarest:projects-get config-ref="Jirarest" projectIdOrKey="#[flowVars.projectIdOrKey]" />
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
projectIdOrKey |
project id or key |
x |
Projects - Get Components
<jirarest:projects-get-components>
Gets a full representation of the specified project's components.
XML Sample
<jirarest:projects-get-components config-ref="Jirarest" projectIdOrKey="#[flowVars.projectIdOrKey]" />
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
projectIdOrKey |
project id or key |
x |
Projects - Get Statuses
<jirarest:projects-get-statuses>
Gets a full representation of the specified project's statuses.
XML Sample
<jirarest:projects-get-statuses config-ref="Jirarest" projectIdOrKey="#[flowVars.projectIdOrKey]" />
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
projectIdOrKey |
project id or key |
x |
Projects - Get Versions
<jirarest:projects-get-versions>
Gets a full representation of the specified project's versions.
XML Sample
<jirarest:projects-get-versions config-ref="Jirarest" projectIdOrKey="#[flowVars.projectIdOrKey]" />
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
projectIdOrKey |
project id or key |
x |
Project Categories - Get all
<jirarest:project-categories-get-all>
Gets a full representation of the project categories.
XML Sample
<jirarest:project-categories-get-all config-ref="Jirarest"/>
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
Project Categories - Create
<jirarest:project-categories-create>
DataSense enabled
Create a project category
XML Sample
<jirarest:project-categories-create config-ref="Jirarest"/>
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
body |
project category input map |
#[payload] |
|
Project Categories - Get
<jirarest:project-categories-get>
Gets a specific project category
XML Sample
<jirarest:project-categories-get config-ref="Jirarest" id="#[flowVars.id]" />
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
id |
id of the project category |
x |
Project Categories - Update
<jirarest:project-categories-update>
DataSense enabled
Updates a project category
XML Sample
<jirarest:project-categories-update config-ref="Jirarest" id="#[flowVars.id]" />
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
id |
id of the project category |
x |
||
body |
project category input map |
#[payload] |
|
Project Categories - Delete
<jirarest:project-categories-delete>
Deletes a specific project category
XML Sample
<jirarest:project-categories-delete config-ref="Jirarest" id="#[flowVars.id]" />
Search - JQL
<jirarest:search>
Paged Operation
Searches for issues using JQL.
XML Sample
<jirarest:search config-ref="Jirarest"/>
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
jql |
a JQL query string |
#[payload] |
|
|
validateQuery |
boolean |
whether to validate the JQL query |
false |
|
fields |
the list of fields to return for each issue. By default, all navigable fields are returned. |
|
||
expand |
A comma-separated list of the parameters to expand. |
|
||
pagingConfiguration |
PagingConfiguration |
x |
Returns
Return Java Type | Description |
---|---|
ProviderAwarePagingDelegate<Map<String,Object>,JiraRestConnector> |
Map with representation of JIRA issues |
Users - Get
<jirarest:users-get>
Gets requested user
XML Sample
<jirarest:users-get config-ref="Jirarest"/>
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
userName |
the user name (specify only one) |
|
||
key |
the user key |
|
Users - Create
<jirarest:users-create>
DataSense enabled
Create user. By default created user will not be notified with email. If password field is not set then password will be randomly generated.
XML Sample
<jirarest:users-create config-ref="Jirarest"/>
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
body |
user input map |
#[payload] |
|
Users - Delete
<jirarest:users-delete>
Deletes requested user
XML Sample
<jirarest:users-delete config-ref="Jirarest"/>
Users - Get all assignable
<jirarest:users-get-all-assignable>
Paged Operation
Returns a list of users that match the search string. This resource cannot be accessed anonymously. Please note that this resource should be called with an issue key when a list of assignable users is retrieved for editing. For create only a project key should be supplied. The list of assignable users may be incorrect if it's called with the project key for editing.
XML Sample
<jirarest:users-get-all-assignable config-ref="Jirarest"/>
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
userName |
user name |
|
||
project |
the key of the project we are finding assignable users for |
|
||
issueKey |
the issue key for the issue being edited we need to find assignable users for. |
|
||
pagingConfiguration |
PagingConfiguration |
x |
Returns
Return Java Type | Description |
---|---|
ProviderAwarePagingDelegate<Map<String,Object>,JiraRestConnector> |
List with representation of JIRA users |
Users - Get all assignable multiproject
<jirarest:users-get-all-assignable-multiproject>
Paged Operation
Returns a list of users that match the search string and can be assigned issues for all the given projects. This resource cannot be accessed anonymously.
XML Sample
<jirarest:users-get-all-assignable-multiproject config-ref="Jirarest"/>
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
userName |
user name |
#[payload] |
|
|
projectKeys |
the keys of the projects we are finding assignable users for, comma-separated |
|
||
pagingConfiguration |
PagingConfiguration |
x |
Returns
Return Java Type | Description |
---|---|
ProviderAwarePagingDelegate<Map<String,Object>,JiraRestConnector> |
List with representation of JIRA users |
Users - Search
<jirarest:users-search>
Paged Operation
Returns a list of users that match the search string. This resource cannot be accessed anonymously.
XML Sample
<jirarest:users-search config-ref="Jirarest"/>
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
userName |
user name |
#[payload] |
|
|
includeActive |
boolean |
If true, then active users are included in the results (default true) |
true |
|
includeInactive |
boolean |
If true, then inactive users are included in the results (default false) |
false |
|
pagingConfiguration |
PagingConfiguration |
x |
Returns
Return Java Type | Description |
---|---|
ProviderAwarePagingDelegate<Map<String,Object>,JiraRestConnector> |
List with representation of JIRA users |
Versions - Create
<jirarest:versions-create>
DataSense enabled
Create a version
XML Sample
<jirarest:versions-create config-ref="Jirarest"/>
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
body |
version input map |
#[payload] |
|
Versions - Get
<jirarest:versions-get>
Gets a specific version
XML Sample
<jirarest:versions-get config-ref="Jirarest" id="#[flowVars.id]" />
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
id |
the id of the version |
x |
Versions - Update
<jirarest:versions-update>
DataSense enabled
Updates a version
XML Sample
<jirarest:versions-update config-ref="Jirarest" id="#[flowVars.id]" />
Attributes
Name | Java Type | Description | Default Value | Required |
---|---|---|---|---|
config-ref |
Specify which config to use |
x |
||
id |
the id of the version |
x |
||
body |
version input map |
#[payload] |
|