Jira Connector 1.0 Reference
Anypoint Connector for Jira (Jira Connector) enables you to interface with the Jira platform without having to interact with the Jira API directly.
Configurations
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Name |
String |
The name for this configuration. Connectors reference the configuration with this name. |
x |
|
Connection |
The connection types that can be provided to this configuration. |
x |
||
Response Timeout |
Number |
Timeout for the request to the remote service. |
1 |
|
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
MINUTES |
|
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to AUTO automatically defines the best strategy based on the request content. |
AUTO |
|
Name |
String |
The identifier of this element and used in other components to reference it. |
x |
|
Expiration Policy |
Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the instance expires at the exact moment that it becomes eligible. Mule purges the instances as appropriate. |
Connection Types
| Jira Connector does not support authentication via personal access tokens (PATs). |
Basic Auth Connection Provider
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Default Headers |
Array of Default Header |
|||
Query Parameters |
Array of Default Query Param |
|||
Connection Timeout |
Number |
Timeout for establishing connections to the remote service. |
30 |
|
Connection Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Connection Timeout. |
SECONDS |
|
Use Persistent Connections |
Boolean |
If false, each connection is closed after the first request is completed. |
true |
|
Max Connections |
Number |
Maximum number of outbound connections to keep open at the same time. |
-1 |
|
Connection Idle Timeout |
Number |
Timeout for how long a connection can remain idle before it is closed. |
30 |
|
Connection Idle Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Connection Idle Timeout. |
SECONDS |
|
Proxy Config |
Reusable configuration element for outbound connections through a proxy. |
|||
Stream Response |
Boolean |
Whether or not to stream received responses. |
false |
|
Response Buffer Size |
Number |
The space in bytes for the buffer where the HTTP response will be stored. |
-1 |
|
Username |
String |
The username used to authenticate the requests. |
||
Password |
String |
The password used to authenticate the requests. |
||
Base Uri |
String |
Base URI for the parameter. Each instance or tenant gets its own base URI. |
||
Protocol |
Enumeration, one of:
|
Protocol to use for communication. Valid values are HTTP and HTTPS. |
HTTP |
|
TLS Configuration |
||||
Reconnection |
When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy. |
Oauth2 Connection Provider
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Default Headers |
Array of Default Header |
|||
Query Parameters |
Array of Default Query Param |
|||
Connection Timeout |
Number |
Timeout for establishing connections to the remote service. |
30 |
|
Connection Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Connection Timeout. |
SECONDS |
|
Use Persistent Connections |
Boolean |
If false, each connection is closed after the first request is completed. |
true |
|
Max Connections |
Number |
Maximum number of outbound connections that will be kept open concurrently. |
-1 |
|
Connection Idle Timeout |
Number |
Timeout for how long a connection can remain idle before it is closed. |
30 |
|
Connection Idle Timeout Unit |
Enumeration, one of:
|
A time unit which qualifies the connection Idle Timeout |
SECONDS |
|
Proxy Config |
Reusable configuration element for outbound connections through a proxy |
|||
Stream Response |
Boolean |
Whether or not to stream received responses. |
false |
|
Response Buffer Size |
Number |
The space in bytes for the buffer where the HTTP response will be stored. |
-1 |
|
Base Uri |
String |
Parameter base URI. Each instance or tenant gets its own base URI. |
||
Audience |
String |
Base URL of the Atlassian API. |
x |
|
Prompt |
String |
Set to consent so that the screen prompting the user to grant access displays. |
x |
|
State |
String |
Set this to a value that is associated with the user you are directing to the authorization URL, for example, a hash of the user’s session ID. |
||
Protocol |
Enumeration, one of:
|
Protocol to use for communication. Valid values are HTTP and HTTPS |
HTTP |
|
TLS Configuration |
||||
Reconnection |
When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy. |
|||
Consumer Key |
String |
OAuth consumer key as registered with the service provider. |
x |
|
Consumer Secret |
String |
OAuth consumer secret as registered with the service provider. |
x |
|
Authorization Url |
String |
Service provider’s authorization endpoint URL. |
||
Access Token Url |
String |
The service provider’s accessToken endpoint URL |
||
Scopes |
String |
The OAuth scopes to request during the OAuth dance. If not provided, this value defaults to the OAuth scopes in the annotation. |
|
|
Resource Owner Id |
String |
The resource owner ID each component should use if the resource owner ID is not otherwise referenced. |
||
Before |
String |
Name of a flow to execute immediately before starting the OAuth dance. |
||
After |
String |
Name of a flow to execute immediately after an access token is received. |
||
Listener Config |
String |
A reference to a <http:listener-config /> to use to create the listener that will receive the access token callback endpoint. |
x |
|
Callback Path |
String |
Path of the access token callback endpoint. |
x |
|
Authorize Path |
String |
Path of the local HTTP endpoint that triggers the OAuth dance. |
x |
|
External Callback Url |
String |
If the callback endpoint is behind a proxy or should be accessed through a non direct URL, use this parameter to tell the OAuth provider the URL to use to access the callback. |
||
Object Store |
String |
A reference to the object store to use to store each resource owner ID’s data. If this value is not specified, Mule automatically provisions the default object store. |
Get Comments By Ids
<jira:create-rest-api3-comment-list>
Returns a paginated list of just the comments for a list of comments specified by comment IDs. This operation can be accessed anonymously.
Permissions required:
Comments are returned when:
-
The user has Browse projects project permission for the project containing the comment.
-
If issue-level security is configured, issue-level security permission to view the issue.
-
If the comment has visibility restrictions, belongs to the group, or has the role visibility is restricted to.
This operation makes an HTTP POST request to the /rest/api/3/comment/list endpoint
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
expand |
String |
Use
|
||
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create Component
<jira:create-rest-api3-component>
Creates a component. Use components to provide containers for issues within a project. This operation can be accessed anonymously.
Permissions required:
-
Administer projects project permission for the project in which the component is created
-
Administer Jira global permission.
This operation makes an HTTP POST request to the /rest/api/3/component endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create Custom Field Options
<jira:create-rest-api3-custom-field-option-by-field-id>
This operation is deprecated and becomes unavailable on 8 May 2021. Use Create custom field options (context) instead. See Deprecation of custom field options for details.
Creates options and, where the custom select field is of the type Select List (cascading), cascading options for a custom select field. The options are added to the global context of the field. Note that this operation only works for issue field select list options created in Jira or using operations from the [Issue custom field options](#api-group-Issue-custom-field-options) resource, it cannot be used with issue field select list options created by Connect apps.
Permissions required:
Administer Jira global permission.
This operation makes an HTTP POST request to the /rest/api/3/customField/{fieldId}/option endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Field Id |
Number |
The ID of the custom field. Note: This is the numeric part of the of the field ID. For example, for a field with the ID customfield\_10075 use 10075. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create Dashboard
<jira:create-rest-api3-dashboard>
Creates a dashboard.
Permissions required:
None.
This operation makes an HTTP POST request to the /rest/api/3/dashboard endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Copy Dashboard
<jira:create-rest-api3-dashboard-copy-by-id>
Copies a dashboard. Any values provided in the dashboard parameter replace those in the copied dashboard.
Permissions required:
None
The dashboard to be copied must be owned by or shared with the user. This operation makes an HTTP POST request to the /rest/api/3/dashboard/{id}/copy endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
id |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Analyse Expression
<jira:create-rest-api3-expression-analyse>
Analyzes and validates Jira expressions. As an experimental feature, this operation can also attempt to type-check the expressions. Learn more about Jira expressions in the documentation.
Permissions required:
None.
This operation makes an HTTP POST request to the /rest/api/3/expression/analyse endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
check |
Enumeration, one of:
|
The check to perform:
|
SYNTAX |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Evaluate Jira Expression
<jira:create-rest-api3-expression-eval>
Evaluates a Jira expression and returns its value. This resource can be used to test Jira expressions that you plan to use elsewhere, or to fetch data in a flexible way. Consult the Jira expressions documentation for more details.
Context variables
The following context variables are available to Jira expressions evaluated by this resource. Their presence depends on various factors; usually you need to manually request them in the context object sent in the payload, but some of them are added automatically under certain conditions.
-
user(User): The current user. Always available and equal tonullif the request is anonymous. -
app(App): The Connect app that made the request. Available only for authenticated requests made by Connect Apps (read more here: Authentication for Connect apps). -
issue(Issue): The current issue. Available only when the issue is provided in the request context object. -
issues(List of Issues): A collection of issues matching a JQL query. Available only when JQL is provided in the request context object. -
project(Project): The current project. Available only when the project is provided in the request context object. -
sprint(Sprint): The current sprint. Available only when the sprint is provided in the request context object. -
board(Board): The current board. Available only when the board is provided in the request context object. -
serviceDesk(ServiceDesk): The current service desk. Available only when the service desk is provided in the request context object. -
customerRequest(CustomerRequest): The current customer request. Available only when the customer request is provided in the request context object. This operation can be accessed anonymously.
Permissions required:
None.
However, an expression may return different results for different users depending on their permissions. For example, different users may see different comments on the same issue. Permission to access Jira Software is required to access Jira Software context variables (board and sprint) or fields (for example, issue.sprint).
This operation makes an HTTP POST request to the /rest/api/3/expression/eval endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
expand |
String |
Use |
||
Body |
Any |
Content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create Custom Field
<jira:create-rest-api3-field>
Creates a custom field.
Permissions required:
Administer Jira global permission.
This operation makes an HTTP POST request to the /rest/api/3/field endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create Custom Field Context
<jira:create-rest-api3-field-context-by-field-id>
Creates a custom field context. If projectIds is empty, a global context is created. A global context is one that applies to all project. If issueTypeIds is empty, the context applies to all issue types.
Permissions required:
Administer Jira global permission.
This operation makes an HTTP POST request to the /rest/api/3/field/{fieldId}/context endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Field Id |
String |
The ID of the custom field. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Remove Issue Types From Context
<jira:create-rest-api3-field-context-issuetype-remove-by-field-id-context-id>
Removes issue types from a custom field context. A custom field context without any issue types applies to all issue types.
Permissions required:
Administer Jira global permission.
This operation makes an HTTP POST request to the /rest/api/3/field/{fieldId}/context/{contextId}/issuetype/remove endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Field Id |
String |
The ID of the custom field. |
x |
|
Context Id |
Number |
The ID of the context. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
Timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Custom Field Contexts For Projects And Issue Types
<jira:create-rest-api3-field-context-mapping-by-field-id>
Returns a paginated list of project and issue type mappings and, for each mapping, the ID of a custom field context that applies to the project and issue type. If there is no custom field context assigned to the project then, if present, the custom field context that applies to all projects is returned if it also applies to the issue type or all issue types. If a custom field context is not found, the returned custom field context ID is null. Duplicate project and issue type mappings cannot be provided in the request. The order of the returned values is the same as provided in the request.
Permissions required:
Administer Jira global permission.
This operation makes an HTTP POST request to the /rest/api/3/field/{fieldId}/context/mapping endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Field Id |
String |
The ID of the custom field. |
x |
|
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
50 |
|
Body |
Any |
the content to use |
#[payload] |
|
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create Custom Field Option
<jira:create-rest-api3-field-context-option-by-field-id-context-id>
Creates options and, where the custom select field is of the type Select List (cascading), cascading options for a custom select field. The options are added to a context of the field. The maximum number of options that can be created per request is 1000 and each field can have a maximum of 10000 options. This operation works for custom field options created in Jira or the operations from this resource. To work with the issue field, select list options created for Connect apps use the Issue custom field options operations.
Permissions required:
Administer Jira global permission.
This operation makes an HTTP POST request to the /rest/api/3/field/{fieldId}/context/{contextId}/option endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Field Id |
String |
The ID of the custom field. |
x |
|
Context Id |
Number |
The ID of the context. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Remove Custom Field Context From Projects
<jira:create-rest-api3-field-context-project-remove-by-field-id-context-id>
Removes a custom field context from projects. A custom field context without any projects applies to all projects. Removing all projects from a custom field context would result in it applying to all projects. If any project in the request is not assigned to the context, or the operation would result in two global contexts for the field, the operation fails.
Permissions required:
Administer Jira global permission.
This operation makes an HTTP POST request to the /rest/api/3/field/{fieldId}/context/{contextId}/project/remove endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Field Id |
String |
The ID of the custom field. |
x |
|
Context Id |
Number |
The ID of the context. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create Issue Field Option
<jira:create-rest-api3-field-option-by-field-key>
Creates an option for a select list issue field. Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the [Issue custom field options](#api-group-Issue-custom-field-options) resource.
Permissions required:
Administer Jira global permission.
Jira permissions are not required for the app providing the field.
This operation makes an HTTP POST request to the /rest/api/3/field/{fieldKey}/option endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Field Key |
String |
The field key is specified in the following format:
|
x |
|
Body |
Any |
Content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for requests to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create Filter
<jira:create-rest-api3-filter>
Creates a filter. The filter is shared according to the [default share scope](#api-rest-api-3-filter-post). The filter is not selected as a favorite.
Permissions required:
Permission to access Jira.
This operation makes an HTTP POST request to the /rest/api/3/filter endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
expand |
String |
Use
|
||
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Add Share Permission
<jira:create-rest-api3-filter-permission-by-id>
Add a share permissions to a filter. If you add a global share permission (one for all logged-in users or the public) it will overwrite all share permissions for the filter. Be aware that this operation uses different objects for updating share permissions compared to [Update filter](#api-rest-api-3-filter-id-put).
Permissions required:
Share dashboards and filters global permission and the user must own the filter.
This operation makes an HTTP POST request to the /rest/api/3/filter/{id}/permission endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the filter. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create Group
<jira:create-rest-api3-group>
Creates a group.
Permissions required:
Site administration (that is, member of the site-admin [group](https://confluence.atlassian.com/x/24xjL)).
This operation makes an HTTP POST request to the /rest/api/3/group endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Add User To Group
<jira:create-rest-api3-group-user>
Adds a user to a group.
Permissions required: Site administration (that is, member of the site-admin [group](https://confluence.atlassian.com/x/24xjL)).
This operation makes an HTTP POST request to the /rest/api/3/group/user endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
groupname |
String |
The name of the group (case sensitive). |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create Issue
<jira:create-rest-api3-issue>
Creates an issue or, where the option to create subtasks is enabled in Jira, a subtask. A transition may be applied, to move the issue or subtask to a workflow step other than the default start step, and issue properties set. The content of the issue or subtask is defined using update and fields. The fields that can be set in the issue or subtask are determined using the [ Get create issue metadata](#api-rest-api-3-issue-createmeta-get). These are the same fields that appear on the issue’s create screen. Note that the description, environment, and any textarea type custom fields (multi-line text fields) take Atlassian Document Format content. Single line custom fields (textfield) accept a string and don’t handle Atlassian Document Format content.
Creating a subtask differs from creating an issue as follows:
-
issueTypemust be set to a subtask issue type (use [ Get create issue metadata](#api-rest-api-3-issue-createmeta-get) to find subtask issue types). -
parentmust contain the ID or key of the parent issue. In a next-gen project any issue may be made a child providing that the parent and child are members of the same project. In a classic project the parent field is only valid for subtasks.
Permissions required:
Browse projects and Create issues [project permissions](https://confluence.atlassian.com/x/yodKLg) for the project in which the issue or subtask is created.
This operation makes an HTTP POST request to the /rest/api/3/issue endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Update History |
Boolean |
Whether the project in which the issue is created is added to the user’s Recently viewed project list, as shown under Projects in Jira. |
false |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Add Attachment
<jira:create-rest-api3-issue-attachments-by-issue-id-or-key>
Adds one or more attachments to an issue. Attachments are posted as multipart/form-data ([RFC 1867](https://www.ietf.org/rfc/rfc1867.txt)).
Note that:
-
The request must have a
X-Atlassian-Token: no-checkheader, if not it is blocked. -
The name of the multipart/form-data parameter that contains the attachments must be
file. The following example uploads a file called myfile.txt to the issue TEST-123:curl -D- -u admin:admin -X POST -H "X-Atlassian-Token: no-check" -F "file=@myfile.txt" https://your-domain.atlassian.net/rest/api/3/issue/TEST-123/attachmentsTip: Use a client library. Many client libraries have classes for handling multipart POST operations. For example, in Java, the Apache HTTP Components library provides a MultiPartEntity) class for multipart POST operations. This operation can be accessed anonymously.
Permissions required:
-
Browse Projects and Create attachments project permission for the project that the issue is in.
-
If issue-level security is configured, issue-level security permission to view the issue.
This operation makes an HTTP POST request to the /rest/api/3/issue/{issueIdOrKey}/attachments endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Id Or Key |
String |
The ID or key of the issue that attachments are added to. |
x |
|
Body |
String |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create Issues
<jira:create-rest-api3-issue-bulk>
Creates issues and, where the option to create subtasks is enabled in Jira, subtasks. Transitions may be applied, to move the issues or subtasks to a workflow step other than the default start step, and issue properties set. The content of each issue or subtask is defined using update and fields. The fields that can be set in the issue or subtask are determined using the [ Get create issue metadata](#api-rest-api-3-issue-createmeta-get). These are the same fields that appear on the issues' create screens. Note that the description, environment, and any textarea type custom fields (multi-line text fields) take Atlassian Document Format content. Single line custom fields (textfield) accept a string and don’t handle Atlassian Document Format content.
Creating a subtask differs from creating an issue as follows:
-
issueTypemust be set to a subtask issue type (use [ Get create issue metadata](#api-rest-api-3-issue-createmeta-get) to find subtask issue types). -
parentthe must contain the ID or key of the parent issue.
Permissions required:
Browse projects and Create issues project permissions for the project in which each issue or subtask is created.
This operation makes an HTTP POST request to the /rest/api/3/issue/bulk endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Add Comment
<jira:create-rest-api3-issue-comment-by-issue-id-or-key>
Adds a comment to an issue. This operation can be accessed anonymously.
Permissions required:
-
Browse projects and Add comments project permission for the project that the issue containing the comment is in.
-
If issue-level security is configured, issue-level security permission to view the issue.
This operation makes an HTTP POST request to the /rest/api/3/issue/{issueIdOrKey}/comment endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Id Or Key |
String |
The ID or key of the issue. |
x |
|
expand |
String |
Use |
||
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Link Issues
<jira:create-rest-api3-issue-link>
Creates a link between two issues. Use this operation to indicate a relationship between two issues and optionally add a comment to the from (outward) issue. To use this resource the site must have Issue Linking enabled. This resource returns nothing on the creation of an issue link. To obtain the ID of the issue link, use linked issue key?fields=issuelinks. If the link request duplicates a link, the response indicates that the issue link was created. If the request included a comment, the comment is added. This operation can be accessed anonymously.
Permissions required:
-
Browse project project permission for all the projects containing the issues to be linked,
-
Link issues project permission on the project containing the from (outward) issue,
-
If issue-level security is configured, issue-level security permission to view the issue.
-
If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.
This operation makes an HTTP POST request to the /rest/api/3/issueLink endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create Issue Link Type
<jira:create-rest-api3-issue-link-type>
Creates an issue link type. Use this operation to create descriptions of the reasons why issues are linked. The issue link type consists of a name and descriptions for a link’s inward and outward relationships. To use this operation, the site must have issue linking enabled.
Permissions required:
Administer Jira global permission.
This operation makes an HTTP POST request to the /rest/api/3/issueLinkType endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Notify
<jira:create-rest-api3-issue-notify-by-issue-id-or-key>
Creates an email notification for an issue and adds it to the mail queue.
Permissions required:
-
Browse Projects project permission for the project that the issue is in.
-
If issue-level security is configured, issue-level security permission to view the issue.
This operation makes an HTTP POST request to the /rest/api/3/issue/{issueIdOrKey}/notify endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Id Or Key |
String |
ID or key of the issue that the notification is sent for. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Bulk Set Issues Properties
<jira:create-rest-api3-issue-properties>
Sets the values of entity properties on issues. It can set up to 10 entity properties on up to 10,000 issues. The value of the request body must be a valid, non-empty JSON. The maximum length of single issue property value is 32768 characters. This operation can be accessed anonymously.
This operation is:
-
transactional, either all properties are updated in all eligible issues or, when errors occur, no properties are updated.
-
[asynchronous](#async). Follow the
locationlink in the response to determine the status of the task and use [Get task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates.
Permissions required:
-
Browse projects and Edit issues project permissions for the project containing the issue.
-
If issue-level security is configured, issue-level security permission to view the issue.
This operation makes an HTTP POST request to the /rest/api/3/issue/properties endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create Or Update Remote Issue Link
<jira:create-rest-api3-issue-remotelink-by-issue-id-or-key>
Creates or updates a remote issue link for an issue. If a globalId is provided and a remote issue link with that global ID is found it is updated. Any fields without values in the request are set to null. Otherwise, the remote issue link is created. This operation requires issue linking to be active. This operation can be accessed anonymously.
Permissions required:
-
Browse projects and Link issues project permission for the project that the issue is in.
-
If issue-level security is configured, issue-level security permission to view the issue.
This operation makes an HTTP POST request to the /rest/api/3/issue/{issueIdOrKey}/remotelink endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Id Or Key |
String |
The ID or key of the issue. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Do Transition
<jira:create-rest-api3-issue-transitions-by-issue-id-or-key>
Performs an issue transition and, if the transition has a screen, updates the fields from the transition screen. sortByCategory To update the fields on the transition screen, specify the fields in the fields or update parameters in the request body. Get details about the fields using [Get transitions](#api-rest-api-3-issue-issueIdOrKey-transitions-get) with the transitions.fields expand. This operation can be accessed anonymously.
Permissions required:
-
Browse projects and Transition issues project permission for the project that the issue is in.
-
If issue-level security is configured, issue-level security permission to view the issue.
This operation makes an HTTP POST request to the /rest/api/3/issue/{issueIdOrKey}/transitions endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Id Or Key |
String |
The ID or key of the issue. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Add Vote
<jira:create-rest-api3-issue-votes-by-issue-id-or-key>
Adds the user’s vote to an issue. This is the equivalent of the user clicking Vote on an issue in Jira. This operation requires the Allow users to vote on issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application options for details.
Permissions required:
-
Browse projects project permission for the project that the issue is in.
-
If issue-level security is configured, issue-level security permission to view the issue.
This operation makes an HTTP POST request to the /rest/api/3/issue/{issueIdOrKey}/votes endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Id Or Key |
String |
The ID or key of the issue. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Add Watcher
<jira:create-rest-api3-issue-watchers-by-issue-id-or-key>
Adds a user as a watcher of an issue by passing the account ID of the user. For example, "123456789". If no user is specified the calling user is added. This operation requires the Allow users to watch issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application options for details.
Permissions required:
-
Browse projects project permission for the project that the issue is in.
-
If issue-level security is configured, issue-level security permission to view the issue.
-
To add users other than themselves to the watchlist, Manage watcher list project permission for the project that the issue is in.
This operation makes an HTTP POST request to the /rest/api/3/issue/{issueIdOrKey}/watchers endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Id Or Key |
String |
The ID or key of the issue. |
x |
|
Body |
String |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Add Worklog
<jira:create-rest-api3-issue-worklog-by-issue-id-or-key>
Adds a worklog to an issue. Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking. This operation can be accessed anonymously.
Permissions required:
-
Browse projects and Work on issues project permission for the project that the issue is in.
-
If issue-level security is configured, issue-level security permission to view the issue.
This operation makes an HTTP POST request to the /rest/api/3/issue/{issueIdOrKey}/worklog endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Id Or Key |
String |
The ID or key the issue. |
x |
|
Notify Users |
Boolean |
Whether users watching the issue are notified by email. |
true |
|
Adjust Estimate |
Enumeration, one of:
|
Defines how to update the issue’s time estimate, the options are:
|
AUTO |
|
New Estimate |
String |
The value to set as the issue’s remaining time estimate, as days (#d), hours (\#h), or minutes (\#m or \#). For example, 2d. Required when |
||
Reduce By |
String |
The amount to reduce the issue’s remaining estimate by, as days (\#d), hours (\#h), or minutes (\#m). For example, 2d. Required when |
||
expand |
String |
Use |
||
Override Editable Flag |
Boolean |
Whether the worklog entry should be added to the issue even if the issue is not editable, because jira.issue.editable set to false or missing. For example, the issue is closed. Only connect app users with admin scope permission can use this flag. |
false |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create Issue Type
<jira:create-rest-api3-issuetype>
Creates an issue type and adds it to the default issue type scheme. Permissions required: Administer Jira global permission.
This operation makes an HTTP POST request to the /rest/api/3/issuetype endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create Issue Type Avatar
<jira:create-rest-api3-issuetype-avatar2-by-id>
Loads an avatar for the issue type. Specify the avatar’s local file location in the body of the request. Also, include the following headers:
-
X-Atlassian-Token: no-checkTo prevent XSRF protection blocking the request, for more information see [Special Headers](#special-request-headers). -
Content-Type: image/image typeValid image types are JPEG, GIF, or PNG. For example:curl --request POST \ --user email@example.com: \ --header 'X-Atlassian-Token: no-check' \ --header 'Content-Type: image/< image_type>' \ --data-binary "<@/path/to/file/with/your/avatar>" \ --url 'https://your-domain.atlassian.net/rest/api/3/issuetype/{issueTypeId}'This
The avatar is cropped to a square. If no crop parameters are specified, the square originates at the top left of the image. The length of the square’s sides is set to the smaller of the height or width of the image. The cropped image is then used to create avatars of 16x16, 24x24, 32x32, and 48x48 in size. After creating the avatar, use [Update issue type](#api-rest-api-3-issuetype-id-put) to set it as the issue type’s displayed avatar.
Permissions required:
Administer Jira global permission.
This operation makes an HTTP POST request to the /rest/api/3/issuetype/{id}/avatar2 endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
The ID of the issue type. |
x |
|
x |
Number |
The X coordinate of the top-left corner of the crop region. |
0 |
|
y |
Number |
The Y coordinate of the top-left corner of the crop region. |
0 |
|
size |
Number |
The length of each side of the crop region. |
x |
|
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create Issue Type Scheme
<jira:create-rest-api3-issuetypescheme>
Creates an issue type scheme.
Permissions required:
Administer Jira global permission.
This operation makes an HTTP POST request to the /rest/api/3/issuetypescheme endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create Issue Type Screen Scheme
<jira:create-rest-api3-issuetypescreenscheme>
Creates an issue type screen scheme.
Permissions required:
Administer Jira global permission.
This operation makes an HTTP POST request to the /rest/api/3/issuetypescreenscheme endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Remove Mappings From Issue Type Screen Scheme
<jira:create-rest-api3-issuetypescreenscheme-mapping-remove-by-issue-type-screen-scheme-id>
Removes issue type to screen scheme mappings from an issue type screen scheme.
Permissions required:
Administer Jira global permission.
This operation makes an HTTP POST request to the /rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping/remove endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Type Screen Scheme Id |
String |
The ID of the issue type screen scheme. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Match Issues
<jira:create-rest-api3-jql-match>
Checks whether one or more issues will be returned by one or more JQL queries.
Permissions required:
None, however, issues are only matched against JQL queries where the user has:
-
Browse projects project permission for the project that the issue is in.
-
If issue-level security is configured, issue-level security permission to view the issue.
This operation makes an HTTP POST request to the /rest/api/3/jql/match endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Parse Jql Queries
<jira:create-rest-api3-jql-parse>
Parses and validates JQL queries. Validation is performed in context of the current user. This operation can be accessed anonymously.
Permissions required:
None.
This operation makes an HTTP POST request to the /rest/api/3/jql/parse endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
validation |
Enumeration, one of:
|
How to validate the JQL query and treat the validation results. Validation options include: * |
STRICT |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Migrate Queries
<jira:create-rest-api3-jql-pdcleaner>
Converts one or more JQL queries with user identifiers (username or user key) to equivalent JQL queries with account IDs. You might want to use this operation if your system stores JQL queries and you want to make them GDPR-compliant. For more information about GDPR-related changes, see the migration guide.
Permissions required:
Permission to access Jira.
This operation makes an HTTP POST request to the /rest/api/3/jql/pdcleaner endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Bulk Permissions
<jira:create-rest-api3-permissions-check>
Returns:
-
For a list of global permissions, the global permissions granted to a user.
-
For a list of project permissions and lists of projects and issues, for each project permission a list of the projects and issues a user can access or manipulate. If no account ID is provided, the operation returns details for the logged in user. Note that invalid project and issue IDs are ignored.
-
A maximum of 1000 projects and 1000 issues can be checked.
-
globalPermissions, projectPermissions, projects, permissions, issues having null values in the input are ignored.
-
globalPermissions, permissions having blank string values in the input are ignored This operation can be accessed anonymously.
Permissions required:
Administer Jira global permission to check the permissions for other users, otherwise none. However, Connect apps can make a call from the app server to the product to obtain permission details for any user, without admin permission. This Connect app ability doesn’t apply to calls made using AP.request() in a browser.
This operation makes an HTTP POST request to the /rest/api/3/permissions/check endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Permitted Projects
<jira:create-rest-api3-permissions-project>
Returns all the projects where the user is granted a list of project permissions. This operation can be accessed anonymously.
Permissions required:
None.
This operation makes an HTTP POST request to the /rest/api/3/permissions/project endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors. |
Create Permission Scheme
<jira:create-rest-api3-permissionscheme>
Creates a new permission scheme. You can create a permission scheme with or without defining a set of permission grants.
Permissions required:
Administer Jira global permission.
This operation makes an HTTP POST request to the /rest/api/3/permissionscheme endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
expand |
String |
Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are always included when you specify any value. Expand options include:
|
||
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create Permission Grant
<jira:create-rest-api3-permissionscheme-permission-by-scheme-id>
Creates a permission grant in a permission scheme.
Permissions required:
Administer Jira global permission.
This operation makes an HTTP POST request to the /rest/api/3/permissionscheme/{schemeId}/permission endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Scheme Id |
Number |
The ID of the permission scheme in which to create a new permission grant. |
x |
|
expand |
String |
Use
|
||
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create Project
<jira:create-rest-api3-project>
Creates a project based on a project type template, as shown in the following table:
| Project Type Key | Project Template Key |
|---|---|
|
|
|
|
|
|
The project types are available according to the installed Jira features as follows:
-
Jira Core, the default, enables
businessprojects. -
Jira Service Management enables
service_deskprojects. -
Jira Software enables
softwareprojects.
To determine which features are installed, go to Jira settings > Apps > Manage apps and review the System Apps list. To add Jira Software or Jira Service Management into a JIRA instance, use Jira settings > Apps > Finding new apps. For more information, see Managing add-ons.
Permissions required:
Administer Jira global permission.
This operation makes an HTTP POST request to the /rest/api/3/project endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Archive Project
<jira:create-rest-api3-project-archive-by-project-id-or-key>
Archives a project. Archived projects cannot be deleted. To delete an archived project, restore the project and then delete it. To restore a project, use the Jira UI.
Permissions required:
Administer Jira global permission.
This operation makes an HTTP POST request to the /rest/api/3/project/{projectIdOrKey}/archive endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Project Id Or Key |
String |
The project ID or project key (case sensitive). |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create Project Avatar
<jira:create-rest-api3-project-avatar2-by-project-id-or-key>
Loads an avatar for a project. Specify the avatar’s local file location in the body of the request. Also, include the following headers:
-
X-Atlassian-Token: no-checkTo prevent XSRF protection blocking the request, for more information see [Special Headers](#special-request-headers). -
Content-Type: image/image typeValid image types are JPEG, GIF, or PNG.
Example
curl --request POST ` `--user email@example.com: ` `--header 'X-Atlassian-Token: no-check' ` `--header 'Content-Type: image/< image_type>' ` `--data-binary "<@/path/to/file/with/your/avatar>" ` `--url 'https://your-domain.atlassian.net/rest/api/3/project/{projectIdOrKey}/avatar2'
The avatar is cropped to a square. If no crop parameters are specified, the square originates at the top left of the image. The length of the square’s sides is set to the smaller of the height or width of the image. The cropped image is then used to create avatars of 16x16, 24x24, 32x32, and 48x48 in size. After creating the avatar use [Set project avatar](#api-rest-api-3-project-projectIdOrKey-avatar-put) to set it as the project’s displayed avatar.
Permissions required: Administer projects
This operation makes an HTTP POST request to the /rest/api/3/project/{projectIdOrKey}/avatar2 endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Project Id Or Key |
String |
The ID or (case-sensitive) key of the project. |
x |
|
x |
Number |
The X coordinate of the top-left corner of the crop region. |
0 |
|
y |
Number |
The Y coordinate of the top-left corner of the crop region. |
0 |
|
size |
Number |
The length of each side of the crop region. |
||
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create Project Category
<jira:create-rest-api3-project-category>
Creates a project category.
Permissions required:
Administer Jira global permission
This operation makes an HTTP POST request to the /rest/api/3/projectCategory endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Project Asynchronously
<jira:create-rest-api3-project-delete-by-project-id-or-key>
Deletes a project asynchronously. This operation is:
-
Transactional, that is, if part of the delete fails the project is not deleted.
-
Asynchronous
Follow the location link in the response to determine the status of the task and use [Get task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates.
Permissions required:
Administer Jira global permission.
This operation makes an HTTP POST request to the /rest/api/3/project/{projectIdOrKey}/delete endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Project Id Or Key |
String |
The project ID or project key (case sensitive). |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
restore
<jira:create-rest-api3-project-restore-by-project-id-or-key>
Restores a project from the Jira recycle bin.
Permissions required:
Administer Jira global permission
This operation makes an HTTP POST request to the /rest/api/3/project/{projectIdOrKey}/restore endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Project Id Or Key |
String |
The project ID or project key (case sensitive). |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Add Actor Users
<jira:create-rest-api3-project-role-by-project-id-or-key-id>
Adds actors to a project role for the project. To replace all actors for the project, use [Set actors for project role](#api-rest-api-3-project-projectIdOrKey-role-id-put). This operation can be accessed anonymously.
Permissions required:
Administer Projects project permission for the project or Administer Jira global permission.
This operation makes an HTTP POST request to the /rest/api/3/project/{projectIdOrKey}/role/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Project Id Or Key |
String |
The project ID or project key (case sensitive). |
x |
|
id |
Number |
The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create Project Role
<jira:create-rest-api3-role>
Creates a new project role with no [default actors](#api-rest-api-3-resolution-get). You can use the [Add default actors to project role](#api-rest-api-3-role-id-actors-post) operation to add default actors to the project role after creating it.
| Although a new project role is available to all projects upon creation, any default actors that are associated with the project role are not added to projects that existed prior to the role being created. |
Permissions required:
Administer Jira global permission
This operation makes an HTTP POST request to the /rest/api/3/role endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Add Project Role Actors To Role
<jira:create-rest-api3-role-actors-by-id>
Adds [default actors](#api-rest-api-3-resolution-get) to a role. You can add groups or users, but you cannot add groups and users in the same request. Changing a project role’s default actors does not affect project role members for projects already created.
Permissions required:
Administer Jira global permission
This operation makes an HTTP POST request to the /rest/api/3/role/{id}/actors endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Partial Update Project Role
<jira:create-rest-api3-role-by-id>
Updates either the project role’s name or its description. You cannot update both the name and description at the same time using this operation. If you send a request with a name and a description only the name is updated.
Permissions required:
Administer Jira global permission
This operation makes an HTTP POST request to the /rest/api/3/role/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create Screen
<jira:create-rest-api3-screens>
Creates a screen with a default field tab.
Permissions required:
Administer Jira global permission
This operation makes an HTTP POST request to the /rest/api/3/screens endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Add Field To Default Screen
<jira:create-rest-api3-screens-add-to-default-by-field-id>
Adds a field to the default tab of the default screen.
Permissions required:
Administer Jira global permission
This operation makes an HTTP POST request to the /rest/api/3/screens/addToDefault/{fieldId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Field Id |
String |
The ID of the field. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Add Screen Tab
<jira:create-rest-api3-screens-tabs-by-screen-id>
Creates a tab for a screen.
Permissions required:
Administer Jira global permission
This operation makes an HTTP POST request to the /rest/api/3/screens/{screenId}/tabs endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Screen Id |
Number |
The ID of the screen. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Add Screen Tab Field
<jira:create-rest-api3-screens-tabs-fields-by-screen-id-tab-id>
Adds a field to a screen tab.
Permissions required:
Administer Jira global permission
This operation makes an HTTP POST request to the /rest/api/3/screens/{screenId}/tabs/{tabId}/fields endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Screen Id |
Number |
The ID of the screen. |
x |
|
Tab Id |
Number |
The ID of the screen tab. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Move Screen Tab Field
<jira:create-rest-api3-screens-tabs-fields-move-by-screen-id-tab-id-id>
Moves a screen tab field. If after and position are provided in the request, position is ignored.
Permissions required:
Administer Jira global permission
This operation makes an HTTP POST request to the /rest/api/3/screens/{screenId}/tabs/{tabId}/fields/{id}/move endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Screen Id |
Number |
The ID of the screen. |
x |
|
Tab Id |
Number |
The ID of the screen tab. |
x |
|
id |
String |
The ID of the field. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Move Screen Tab
<jira:create-rest-api3-screens-tabs-move-by-screen-id-tab-id-pos>
Moves a screen tab.
Permissions required:
Administer Jira global permission
This operation makes an HTTP POST request to the /rest/api/3/screens/{screenId}/tabs/{tabId}/move/{pos} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Screen Id |
Number |
The ID of the screen. |
x |
|
Tab Id |
Number |
The ID of the screen tab. |
x |
|
pos |
Number |
The position of tab. The base index is 0. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create Screen Scheme
<jira:create-rest-api3-screenscheme>
Creates a screen scheme.
Permissions required:
Administer Jira global permission
This operation makes an HTTP POST request to the /rest/api/3/screenscheme endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Search For Issues Using Jql Post
<jira:create-rest-api3-search>
Searches for issues using JQL. There is a [GET](#api-rest-api-3-search-get) version of this resource that can be used for smaller JQL query expressions. This operation can be accessed anonymously.
Permissions required:
Issues are included in the response where the user has:
-
Browse projects project permission for the project containing the issue.
-
If issue-level security is configured, issue-level security permission to view the issue.
This operation makes an HTTP POST request to the /rest/api/3/search endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Cancel Task
<jira:create-rest-api3-task-cancel-by-task-id>
Cancels a task.
Permissions required:
Either of:
-
Administer Jira global permission
-
Creator of the task
This operation makes an HTTP POST request to the /rest/api/3/task/{taskId}/cancel endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Task Id |
String |
The ID of the task. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Store Avatar
<jira:create-rest-api3-universal-avatar-type-owner-by-type-entity-id>
Loads a custom avatar for a project or issue type. Specify the avatar’s local file location in the body of the request. Also, include the following headers:
-
X-Atlassian-Token: no-checkTo prevent XSRF protection blocking the request, for more information see [Special Headers](#special-request-headers). -
Content-Type: image/image typeValid image types are JPEG, GIF, or PNG.
Example
curl --request POST ` `--user email@example.com: ` `--header 'X-Atlassian-Token: no-check' ` `--header 'Content-Type: image/< image_type>' ` `--data-binary "<@/path/to/file/with/your/avatar>" ` `--url 'https://your-domain.atlassian.net/rest/api/3/universal_avatar/type/{type}/owner/{entityId}'
The avatar is cropped to a square. If no crop parameters are specified, the square originates at the top left of the image. The length of the square’s sides is set to the smaller of the height or width of the image. The cropped image is then used to create avatars of 16x16, 24x24, 32x32, and 48x48 in size.
After creating the avatar use:
-
[Update issue type](#api-rest-api-3-issuetype-id-put) to set it as the issue type’s displayed avatar.
-
[Set project avatar](#api-rest-api-3-project-projectIdOrKey-avatar-put) to set it as the project’s displayed avatar.
Permissions required:
Administer Jira global permission
This operation makes an HTTP POST request to the /rest/api/3/universal_avatar/type/{type}/owner/{entityId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
type |
Enumeration, one of:
|
The avatar type. |
x |
|
Entity Id |
String |
The ID of the item the avatar is associated with. |
x |
|
x |
Number |
The X coordinate of the top-left corner of the crop region. |
0 |
|
y |
Number |
The Y coordinate of the top-left corner of the crop region. |
0 |
|
size |
Number |
The length of each side of the crop region. |
x |
|
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create User
<jira:create-rest-api3-user>
Creates a user. This resource is retained for legacy compatibility. As soon as a more suitable alternative is available this resource will be deprecated. The option is provided to set or generate a password for the user.
When using the option to generate a password, by omitting password from the request, include "notification": "true" to ensure the user is sent an email advising them that their account is created. This email includes a link for the user to set their password. If the notification isn’t sent for a generated password, the user will need to be sent a reset password request from Jira. If the user exists and has access to Jira, the operation returns a 201 status. If the user exists but does not have access to Jira, the operation returns a 400 status.
Permissions required:
Administer Jira global permission
This operation makes an HTTP POST request to the /rest/api/3/user endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create Version
<jira:create-rest-api3-version>
Creates a project version. This operation can be accessed anonymously.
Permissions required:
Administer Jira global permission or Administer Projects project permission for the project the version is added to.
This operation makes an HTTP POST request to the /rest/api/3/version endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Move Version
<jira:create-rest-api3-version-move-by-id>
Modifies the version’s sequence within the project, which affects the display order of the versions in Jira. This operation can be accessed anonymously.
Permissions required:
Browse projects project permission for the project that contains the version.
This operation makes an HTTP POST request to the /rest/api/3/version/{id}/move endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
The ID of the version to be moved. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete And Replace Version
<jira:create-rest-api3-version-remove-and-swap-by-id>
Deletes a project version. Alternative versions can be provided to update issues that use the deleted version in fixVersion, affectedVersion, or any version picker custom fields. If alternatives are not provided, occurrences of fixVersion, affectedVersion, and any version picker custom field, that contain the deleted version, are cleared. Any replacement version must be in the same project as the version being deleted and cannot be the version being deleted. This operation can be accessed anonymously.
Permissions required:
Administer Jira global permission or Administer Projects project permission for the project that contains the version.
This operation makes an HTTP POST request to the /rest/api/3/version/{id}/removeAndSwap endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
The ID of the version. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Register Dynamic Webhooks
<jira:create-rest-api3-webhook>
Registers webhooks.
Permissions required:
Only Connect apps can use this operation.
This operation makes an HTTP POST request to the /rest/api/3/webhook endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create Workflow Transition Property
<jira:create-rest-api3-workflow-transitions-properties-by-transition-id>
Adds a property to a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see Transition properties and Workflow properties.
Permissions required:
Administer Jira global permission.
This operation makes an HTTP POST request to the /rest/api/3/workflow/transitions/{transitionId}/properties endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Transition Id |
Number |
The ID of the transition. To get the ID, view the workflow in text mode in the Jira admin settings. The ID is shown next to the transition. |
x |
|
key |
String |
The key of the property being added, also known as the name of the property. Set this to the same value as the |
x |
|
Workflow Name |
String |
The name of the workflow that the transition belongs to. |
x |
|
Workflow Mode |
Enumeration, one of:
|
The workflow status. Set to live for inactive workflows or draft for draft workflows. Active workflows cannot be edited. |
LIVE |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create Workflow Scheme
<jira:create-rest-api3-workflowscheme>
Creates a workflow scheme.
Permissions required:
Administer Jira global permission
This operation makes an HTTP POST request to the /rest/api/3/workflowscheme endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Create Workflow Scheme Draft From Parent
<jira:create-rest-api3-workflowscheme-createdraft-by-id>
Create a draft workflow scheme from an active workflow scheme, by copying the active workflow scheme. Note that an active workflow scheme can only have one draft workflow scheme.
Permissions required:
Administer Jira global permission
This operation makes an HTTP POST request to the /rest/api/3/workflowscheme/{id}/createdraft endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the active workflow scheme that the draft is created from. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Worklogs For Ids
<jira:create-rest-api3-worklog-list>
Returns worklog details for a list of worklog IDs. The returned list of worklogs is limited to 1000 items.
Permissions required:
Permission to access Jira, however, worklogs are only returned where either of the following is true:
-
The worklog is set as Viewable by All Users.
-
The user is a member of a project role or group with permission to view the worklog.
This operation makes an HTTP POST request to the /rest/api/3/worklog/list endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
expand |
String |
Use |
||
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Dynamic Modules Resource register Modules post
<jira:create-rest-atlassian-connect1-app-module-dynamic>
Registers a list of modules.
Permissions required:
Only Connect apps can make this request.
This operation makes an HTTP POST request to the /rest/atlassian-connect/1/app/module/dynamic endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Remove Attachment
<jira:delete-rest-api3-attachment-by-id>
Deletes an attachment from an issue. This operation can be accessed anonymously.
Permissions required:
For the project holding the issue containing the attachment:
-
Delete own attachments project permission to delete an attachment created by the calling user.
-
Delete all attachments project permission to delete an attachment created by any user.
This operation makes an HTTP DELETE request to the /rest/api/3/attachment/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
The ID of the attachment. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Comment Property
<jira:delete-rest-api3-comment-properties-by-comment-id-property-key>
Deletes a comment property.
Permissions required:
Either of:
-
Edit All Comments project permission to delete a property from any comment.
-
Edit Own Comments project permission to delete a property from a comment created by the user.
Also, when the visibility of a comment is restricted to a role or group, the user must be a member of that role or group.
This operation makes an HTTP DELETE request to the /rest/api/3/comment/{commentId}/properties/{propertyKey} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Comment Id |
String |
The ID of the comment. |
x |
|
Property Key |
String |
The key of the property. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Component
<jira:delete-rest-api3-component-by-id>
Deletes a component. This operation can be accessed anonymously.
Permissions required:
Administer projects project permission for the project containing the component or Administer Jira global permission.
This operation makes an HTTP DELETE request to the /rest/api/3/component/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
The ID of the component. |
x |
|
Move Issues To |
String |
The ID of the component to replace the deleted component. If this value is null no replacement is made. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Dashboard
<jira:delete-rest-api3-dashboard-by-id>
Deletes a dashboard.
Permissions required:
None The dashboard to be deleted must be owned by the user.
This operation makes an HTTP DELETE request to the /rest/api/3/dashboard/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
The ID of the dashboard. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Dashboard Item Property
<jira:delete-rest-api3-dashboard-items-properties-by-dashboard-id-item-id-property-key>
Deletes a dashboard item property. This operation can be accessed anonymously.
Permissions required:
The user must be the owner of the dashboard. Note, users with the Administer Jira global permission are considered owners of the System dashboard.
This operation makes an HTTP DELETE request to the /rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Dashboard Id |
String |
The ID of the dashboard. |
x |
|
Item Id |
String |
The ID of the dashboard item. |
x |
|
Property Key |
String |
The key of the dashboard item property. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Custom Field Context
<jira:delete-rest-api3-field-context-by-field-id-context-id>
Deletes a custom field context.
Permissions required:
Administer Jira global permission
This operation makes an HTTP DELETE request to the /rest/api/3/field/{fieldId}/context/{contextId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Field Id |
String |
The ID of the custom field. |
x |
|
Context Id |
Number |
The ID of the context. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Custom Field Option
<jira:delete-rest-api3-field-context-option-by-field-id-context-id-option-id>
Deletes a custom field option. Options with cascading options cannot be deleted without deleting the cascading options first. This operation works for custom field options created in Jira or the operations from this resource. To work with the issue field select list options created for Connect apps use the [Issue custom field options (apps)](#api-group-issue-custom-field-options—apps-) operations.
Permissions required:
Administer Jira global permission.
This operation makes an HTTP DELETE request to the /rest/api/3/field/{fieldId}/context/{contextId}/option/{optionId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Field Id |
String |
The ID of the custom field. |
x |
|
Context Id |
Number |
The ID of the context from which an option should be deleted. |
x |
|
Option Id |
Number |
The ID of the option to delete. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Issue Field Option
<jira:delete-rest-api3-field-option-by-field-key-option-id>
Deletes an option from a select list issue field. Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the [Issue custom field options](#api-group-Issue-custom-field-options) resource.
Permissions required:
Administer Jira global permission. Jira permissions are not required for the app providing the field.
This operation makes an HTTP DELETE request to the /rest/api/3/field/{fieldKey}/option/{optionId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Field Key |
String |
The field key is specified in the following format: $(app-key)_\_$(field-key). For example, example-add-on\_\_example-issue-field. To determine the
|
x |
|
Option Id |
Number |
The ID of the option to be deleted. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Replace Issue Field Option
<jira:delete-rest-api3-field-option-issue-by-field-key-option-id>
Deselects an issue-field select-list option from all issues where it is selected. A different option can be selected to replace the deselected option. The update can also be limited to a smaller set of issues by using a JQL query. This is an [asynchronous operation](#async). The response object contains a link to the long-running task. Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the [Issue custom field options](#api-group-Issue-custom-field-options) resource.
Permissions required:
Administer Jira global permission. Jira permissions are not required for the app providing the field.
This operation makes an HTTP DELETE request to the /rest/api/3/field/{fieldKey}/option/{optionId}/issue endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Field Key |
String |
The field key is specified in the following format: $(app-key)_\_$(field-key), for example, example-add-on\_\_example-issue-field. To determine the
|
x |
|
Option Id |
Number |
The ID of the option to be deselected. |
x |
|
Replace With |
Number |
The ID of the option that will replace the currently selected option. |
||
jql |
String |
A JQL query that specifies the issues to be updated. For example, project=10000. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Filter
<jira:delete-rest-api3-filter-by-id>
Deletes a filter.
Permissions required:
Permission to access Jira, however filters can only be deleted by the creator of the filter or a user with Administer Jira global permission.
This operation makes an HTTP DELETE request to the /rest/api/3/filter/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the filter to delete. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Reset Columns
<jira:delete-rest-api3-filter-columns-by-id>
Resets the user’s column configuration for the filter to the default.
Permissions required:
Permission to access Jira, however, columns are only reset for:
-
filters owned by the user.
-
filters shared with a group that the user is a member of.
-
filters shared with a private project that the user has Browse projects project permission for.
-
filters shared with a public project.
-
filters shared with the public.
This operation makes an HTTP DELETE request to the /rest/api/3/filter/{id}/columns endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the filter. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Favourite For Filter
<jira:delete-rest-api3-filter-favourite-by-id>
Removes a filter as a favorite for the user. Note that this operation only removes filters visible to the user from the user’s favorites list. For example, if the user favorites a public filter that is subsequently made private (and is therefore no longer visible on their favorites list) they cannot remove it from their favorites list.
Permissions required:
Permission to access Jira.
This operation makes an HTTP DELETE request to the /rest/api/3/filter/{id}/favourite endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the filter. |
x |
|
expand |
String |
Use
|
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Share Permission
<jira:delete-rest-api3-filter-permission-by-id-permission-id>
Deletes a share permission from a filter.
Permissions required:
Permission to access Jira and the user must own the filter.
This operation makes an HTTP DELETE request to the /rest/api/3/filter/{id}/permission/{permissionId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the filter. |
x |
|
Permission Id |
Number |
The ID of the share permission. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Remove Group
<jira:delete-rest-api3-group>
Deletes a group.
Permissions required:
Site administration (that is, member of the site-admin strategic group).
This operation makes an HTTP DELETE request to the /rest/api/3/group endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
groupname |
String |
The name of the group. |
x |
|
Swap Group |
String |
The group to transfer restrictions to. Only comments and worklogs are transferred. If restrictions are not transferred, comments and worklogs are inaccessible after the deletion. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Remove User From Group
<jira:delete-rest-api3-group-user>
Removes a user from a group.
Permissions required:
Site administration (that is, member of the site-admin group).
This operation makes an HTTP DELETE request to the /rest/api/3/group/user endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
groupname |
String |
The name of the group. |
x |
|
username |
String |
This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. |
||
Account Id |
String |
The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Issue
<jira:delete-rest-api3-issue-by-issue-id-or-key>
Deletes an issue. An issue cannot be deleted if it has one or more subtasks. To delete an issue with subtasks, set deleteSubtasks. This causes the issue’s subtasks to be deleted with the issue. This operation can be accessed anonymously.
Permissions required:
-
Browse projects and Delete issues project permission for the project containing the issue.
-
If issue-level security is configured, issue-level security permission to view the issue.
This operation makes an HTTP DELETE request to the /rest/api/3/issue/{issueIdOrKey} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Id Or Key |
String |
The ID or key of the issue. |
x |
|
Delete Subtasks |
Enumeration, one of:
|
Whether the issue’s subtasks are deleted when the issue is deleted. |
FALSE |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Comment
<jira:delete-rest-api3-issue-comment-by-issue-id-or-key-id>
Deletes a comment.
Permissions required:
-
Browse projects project permission for the project that the issue containing the comment is in.
-
If issue-level security is configured, issue-level security permission to view the issue.
-
Delete all comments project permission to delete any comment or Delete own comments to delete comment created by the user.
-
If the comment has visibility restrictions, the user belongs to the group or has the role visibility is restricted to.
This operation makes an HTTP DELETE request to the /rest/api/3/issue/{issueIdOrKey}/comment/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Id Or Key |
String |
The ID or key of the issue. |
x |
|
id |
String |
The ID of the comment. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Issue Link
<jira:delete-rest-api3-issue-link-by-link-id>
Deletes an issue link. This operation can be accessed anonymously.
Permissions required:
-
Browse project project permission for all the projects containing the issues in the link.
-
Link issues project permission for at least one of the projects containing issues in the link.
-
If issue-level security is configured, permission to view both of the issues.
This operation makes an HTTP DELETE request to the /rest/api/3/issueLink/{linkId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Link Id |
String |
The ID of the issue link. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Issue Link Type
<jira:delete-rest-api3-issue-link-type-by-issue-link-type-id>
Deletes an issue link type. To use this operation, the site must have issue linking enabled.
Permissions required:
Administer Jira global permission.
This operation makes an HTTP DELETE request to the /rest/api/3/issueLinkType/{issueLinkTypeId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Link Type Id |
String |
The ID of the issue link type. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Issue Property
<jira:delete-rest-api3-issue-properties-by-issue-id-or-key-property-key>
Deletes an issue’s property. This operation can be accessed anonymously.
Permissions required:
-
Browse projects and Edit issues [project permissions](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue.
-
If issue-level security is configured, issue-level security permission to view the issue.
This operation makes an HTTP DELETE request to the /rest/api/3/issue/{issueIdOrKey}/properties/{propertyKey} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Id Or Key |
String |
The key or ID of the issue. |
x |
|
Property Key |
String |
The key of the property. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Bulk Delete Issue Property
<jira:delete-rest-api3-issue-properties-by-property-key>
Deletes a property value from multiple issues. The issues to be updated can be specified by filter criteria. The criteria the filter used to identify eligible issues are:
-
entityIdsOnly issues from this list are eligible. -
currentValueOnly issues with the property set to this value are eligible. If both criteria is specified, they are joined with the logical AND: only issues that satisfy both criteria are considered eligible. If no filter criteria are specified, all the issues visible to the user and where the user has the EDIT\_ISSUES permission for the issue are considered eligible.
This operation is:
-
transactional, either the property is deleted from all eligible issues or, when errors occur, no properties are deleted.
-
[asynchronous](#async). Follow the
locationlink in the response to determine the status of the task and use [Get task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates.
Permissions required:
-
Browse projects project permission for each project containing issues.
-
If issue-level security is configured, issue-level security permission to view the issue.
-
Edit issues project permission for each issue.
This operation makes an HTTP DELETE request to the /rest/api/3/issue/properties/{propertyKey} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Property Key |
String |
The key of the property. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Remote Issue Link By Global Id
<jira:delete-rest-api3-issue-remotelink-by-issue-id-or-key>
Deletes the remote issue link from the issue using the link’s global ID. Where the global ID includes reserved URL characters, these must be escaped in the request, for example, pass system=http://www.mycompany.com/support&id=1 as system%3Dhttp%3A%2F%2Fwww.mycompany.com%2Fsupport%26id%3D1.
This operation requires issue linking to be active. This operation can be accessed anonymously.
Permissions required:
-
Browse projects and Link issues project permission for the project that the issue is in.
-
If issue-level security is implemented, issue-level security permission to view the issue.
This operation makes an HTTP DELETE request to the /rest/api/3/issue/{issueIdOrKey}/remotelink endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Id Or Key |
String |
The ID or key of the issue. |
x |
|
Global Id |
String |
The global ID of a remote issue link. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Remote Issue Link By Id
<jira:delete-rest-api3-issue-remotelink-by-issue-id-or-key-link-id>
Deletes a remote issue link from an issue. This operation requires issue linking to be active. This operation can be accessed anonymously.
Permissions required:
-
Browse projects, Edit issues, and Link issues project permission for the project that the issue is in.
-
If issue-level security is configured, issue-level security permission to view the issue.
This operation makes an HTTP DELETE request to the /rest/api/3/issue/{issueIdOrKey}/remotelink/{linkId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Id Or Key |
String |
The ID or key of the issue. |
x |
|
Link Id |
String |
The ID of a remote issue link. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Remove Vote
<jira:delete-rest-api3-issue-votes-by-issue-id-or-key>
Deletes a user’s vote from an issue. This is the equivalent of the user clicking Unvote on an issue in Jira. This operation requires the Allow users to vote on issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application options for details.
Permissions required:
-
Browse projects project permission for the project that the issue is in.
-
If issue-level security is configured, issue-level security permission to view the issue.
This operation makes an HTTP DELETE request to the /rest/api/3/issue/{issueIdOrKey}/votes endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Id Or Key |
String |
The ID or key of the issue. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Remove Watcher
<jira:delete-rest-api3-issue-watchers-by-issue-id-or-key>
Deletes a user as a watcher of an issue. This operation requires the Allow users to watch issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application options for details.
Permissions required:
-
Browse projects project permission for the project that the issue is in.
-
If issue-level security is configured, issue-level security permission to view the issue.
-
To remove users other than themselves from the watchlist, Manage watcher list project permission for the project that the issue is in.
This operation makes an HTTP DELETE request to the /rest/api/3/issue/{issueIdOrKey}/watchers endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Id Or Key |
String |
The ID or key of the issue. |
x |
|
username |
String |
This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. |
||
Account Id |
String |
The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Worklog
<jira:delete-rest-api3-issue-worklog-by-issue-id-or-key-id>
Deletes a worklog from an issue. Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking. This operation can be accessed anonymously.
Permissions required:
-
Browse projects project permission for the project that the issue is in.
-
If issue-level security is configured, issue-level security permission to view the issue.
-
Delete all worklogs project permission to delete any worklog or Delete own worklogs to delete worklogs created by the user,
-
If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
This operation makes an HTTP DELETE request to the /rest/api/3/issue/{issueIdOrKey}/worklog/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Id Or Key |
String |
The ID or key of the issue. |
x |
|
id |
String |
The ID of the worklog. |
x |
|
Notify Users |
Boolean |
Whether users watching the issue are notified by email. |
true |
|
Adjust Estimate |
Enumeration, one of:
|
Defines how to update the issue’s time estimate, the options are: * |
AUTO |
|
New Estimate |
String |
The value to set as the issue’s remaining time estimate, as days (#d), hours (\#h), or minutes (\#m or \#), for example, 2d. Required when |
||
Increase By |
String |
The amount to increase the issue’s remaining estimate by, as days (#d), hours (\#h), or minutes (\#m or \#), for example, 2d. Required when |
||
Override Editable Flag |
Boolean |
Whether the work log entry should be added to the issue even if the issue is not editable, because |
false |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Worklog Property
<jira:delete-rest-api3-issue-worklog-properties-by-issue-id-or-key-worklog-id-property-key>
Deletes a worklog property. This operation can be accessed anonymously.
Permissions required:
-
Browse projects project permission for the project that the issue is in.
-
If issue-level security is configured, issue-level security permission to view the issue.
-
If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
This operation makes an HTTP DELETE request to the /rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties/{propertyKey} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Id Or Key |
String |
The ID or key of the issue. |
x |
|
Worklog Id |
String |
The ID of the worklog. |
x |
|
Property Key |
String |
The key of the property. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Issue Type
<jira:delete-rest-api3-issuetype-by-id>
Deletes the issue type. If the issue type is in use, all uses are updated with the alternative issue type (alternativeIssueTypeId). A list of alternative issue types are obtained from the [Get alternative issue types](#api-rest-api-3-issuetype-id-alternatives-get) resource.
Permissions required:
Administer Jira global permission.
This operation makes an HTTP DELETE request to the /rest/api/3/issuetype/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
The ID of the issue type. |
x |
|
Alternative Issue Type Id |
String |
The ID of the replacement issue type. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Issue Type Property
<jira:delete-rest-api3-issuetype-properties-by-issue-type-id-property-key>
Deletes the issue type property.
Permissions required:
Administer Jira global permission
This operation makes an HTTP DELETE request to the /rest/api/3/issuetype/{issueTypeId}/properties/{propertyKey} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Type Id |
String |
The ID of the issue type. |
x |
|
Property Key |
String |
The key of the property. Use [Get issue type property keys](#api-rest-api-3-issuetype-issueTypeId-properties-get) to get a list of all issue type property keys. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Issue Type Scheme
<jira:delete-rest-api3-issuetypescheme-by-issue-type-scheme-id>
Deletes an issue type scheme. Only issue type schemes used in classic projects can be deleted. Any projects assigned to the scheme are reassigned to the default issue type scheme.
Permissions required:
Administer Jira global permission
This operation makes an HTTP DELETE request to the /rest/api/3/issuetypescheme/{issueTypeSchemeId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Type Scheme Id |
Number |
The ID of the issue type scheme. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Remove Issue Type From Issue Type Scheme
<jira:delete-rest-api3-issuetypescheme-issuetype-by-issue-type-scheme-id-issue-type-id>
Removes an issue type from an issue type scheme. This operation cannot remove:
-
any issue type used by issues.
-
any issue types from the default issue type scheme.
-
the last standard issue type from an issue type scheme.
Permissions required:
Administer Jira global permission
This operation makes an HTTP DELETE request to the /rest/api/3/issuetypescheme/{issueTypeSchemeId}/issuetype/{issueTypeId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Type Scheme Id |
Number |
The ID of the issue type scheme. |
x |
|
Issue Type Id |
Number |
The ID of the issue type. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Issue Type Screen Scheme
<jira:delete-rest-api3-issuetypescreenscheme-by-issue-type-screen-scheme-id>
Deletes an issue type screen scheme.
Permissions required:
Administer Jira global permission
This operation makes an HTTP DELETE request to the /rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Type Screen Scheme Id |
String |
The ID of the issue type screen scheme. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Remove Preference
<jira:delete-rest-api3-mypreferences>
Deletes a preference of the user, which restores the default value of system defined settings.
Note that these keys are deprecated:
-
jira.user.locale The locale of the user. By default, not set. The user takes the instance locale.
-
jira.user.timezone The time zone of the user. By default, not set. The user takes the instance timezone. Use Update a user profile from the user management REST API to manage timezone and locale instead.
Permissions required:
Permission to access Jira.
This operation makes an HTTP DELETE request to the /rest/api/3/mypreferences endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
key |
String |
The key of the preference. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Permission Scheme
<jira:delete-rest-api3-permissionscheme-by-scheme-id>
Deletes a permission scheme.
Permissions required:
Administer Jira global permission
This operation makes an HTTP DELETE request to the /rest/api/3/permissionscheme/{schemeId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Scheme Id |
Number |
The ID of the permission scheme being deleted. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Permission Scheme Entity
<jira:delete-rest-api3-permissionscheme-permission-by-scheme-id-permission-id>
Deletes a permission grant from a permission scheme. See [About permission schemes and grants](#about-permission-schemes) for more details.
Permissions required:
Administer Jira global permission
This operation makes an HTTP DELETE request to the /rest/api/3/permissionscheme/{schemeId}/permission/{permissionId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Scheme Id |
Number |
The ID of the permission scheme to delete the permission grant from. |
x |
|
Permission Id |
Number |
The ID of the permission grant to delete. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Project Avatar
<jira:delete-rest-api3-project-avatar-by-project-id-or-key-id>
Deletes a custom avatar from a project. Note that system avatars cannot be deleted.
Permissions required:
Administer projects project permission
This operation makes an HTTP DELETE request to the /rest/api/3/project/{projectIdOrKey}/avatar/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Project Id Or Key |
String |
The project ID or (case-sensitive) key. |
x |
|
id |
Number |
The ID of the avatar. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Project
<jira:delete-rest-api3-project-by-project-id-or-key>
Deletes a project.
Permissions required: Administer Jira global permission
This operation makes an HTTP DELETE request to the /rest/api/3/project/{projectIdOrKey} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Project Id Or Key |
String |
The project ID or project key (case sensitive). |
x |
|
Enable Undo |
Boolean |
Whether this project is placed in the Jira recycle bin where it will be available for restoration. |
false |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Remove Project Category
<jira:delete-rest-api3-project-category-by-id>
Deletes a project category.
Permissions required: Administer Jira global permission
This operation makes an HTTP DELETE request to the /rest/api/3/projectCategory/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
ID of the project category to delete. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Project Property
<jira:delete-rest-api3-project-properties-by-project-id-or-key-property-key>
Deletes the property from a project. This operation can be accessed anonymously.
Permissions required:
Administer Jira global permission or Administer Projects project permission for the project containing the property.
This operation makes an HTTP DELETE request to the /rest/api/3/project/{projectIdOrKey}/properties/{propertyKey} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Project Id Or Key |
String |
The project ID or project key (case sensitive). |
x |
|
Property Key |
String |
The project property key. Use [Get project property keys](#api-rest-api-3-project-projectIdOrKey-properties-get) to get a list of all project property keys. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Actor
<jira:delete-rest-api3-project-role-by-project-id-or-key-id>
Deletes actors from a project role for the project. To remove default actors from the project role, use [Delete default actors from project role](#api-rest-api-3-role-id-actors-delete). This operation can be accessed anonymously.
Permissions required:
Administer Projects project permission for the project or Administer Jira global permission.
This operation makes an HTTP DELETE request to the /rest/api/3/project/{projectIdOrKey}/role/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Project Id Or Key |
String |
The project ID or project key (case sensitive). |
x |
|
id |
Number |
The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs. |
x |
|
user |
String |
The user account ID of the user to remove from the project role. |
||
group |
String |
The name of the group to remove from the project role. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Project Role Actors From Role
<jira:delete-rest-api3-role-actors-by-id>
Deletes the [default actors](#api-rest-api-3-resolution-get) from a project role. You can delete a group or user, but you cannot delete a group and a user in the same request. Changing a project role’s default actors does not affect project role members for projects already created.
Permissions required:
Administer Jira global permission
This operation makes an HTTP DELETE request to the /rest/api/3/role/{id}/actors endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs. |
x |
|
user |
String |
The user account ID of the user to remove as a default actor. |
||
group |
String |
The group name of the group to be removed as a default actor. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Project Role
<jira:delete-rest-api3-role-by-id>
Deletes a project role. You must specify a replacement project role if you wish to delete a project role that is in use.
Permissions required:
Administer Jira global permission
This operation makes an HTTP DELETE request to the /rest/api/3/role/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the project role to delete. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs. |
x |
|
swap |
Number |
The ID of the project role that will replace the one being deleted. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Screen
<jira:delete-rest-api3-screens-by-screen-id>
Deletes a screen. A screen cannot be deleted if it is used in a screen scheme, workflow, or workflow draft. Only screens used in classic projects can be deleted.
This operation makes an HTTP DELETE request to the /rest/api/3/screens/{screenId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Screen Id |
Number |
The ID of the screen. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Screen Tab
<jira:delete-rest-api3-screens-tabs-by-screen-id-tab-id>
Deletes a screen tab.
Permissions required:
Administer Jira global permission
This operation makes an HTTP DELETE request to the /rest/api/3/screens/{screenId}/tabs/{tabId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Screen Id |
Number |
The ID of the screen. |
x |
|
Tab Id |
Number |
The ID of the screen tab. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Remove Screen Tab Field
<jira:delete-rest-api3-screens-tabs-fields-by-screen-id-tab-id-id>
Removes a field from a screen tab.
Permissions required:
Administer Jira global permission
This operation makes an HTTP DELETE request to the /rest/api/3/screens/{screenId}/tabs/{tabId}/fields/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Screen Id |
Number |
The ID of the screen. |
x |
|
Tab Id |
Number |
The ID of the screen tab. |
x |
|
id |
String |
The ID of the field. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Screen Scheme
<jira:delete-rest-api3-screenscheme-by-screen-scheme-id>
Deletes a screen scheme. A screen scheme cannot be deleted if it is used in an issue type screen scheme. Only screens schemes used in classic projects can be deleted.
Permissions required:
Administer Jira global permission
This operation makes an HTTP DELETE request to the /rest/api/3/screenscheme/{screenSchemeId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Screen Scheme Id |
String |
The ID of the screen scheme. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Avatar
<jira:delete-rest-api3-universal-avatar-type-owner-avatar-by-type-owning-object-id-id>
Deletes an avatar from a project or issue type.
Permissions required:
Administer Jira global permission
This operation makes an HTTP DELETE request to the /rest/api/3/universal_avatar/type/{type}/owner/{owningObjectId}/avatar/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
type |
Enumeration, one of:
|
The avatar type. |
x |
|
Owning Object Id |
String |
The ID of the item the avatar is associated with. |
x |
|
id |
Number |
The ID of the avatar. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Remove User
<jira:delete-rest-api3-user>
Deletes a user.
Permissions required:
Site administration (that is, membership of the site-admin group).
This operation makes an HTTP DELETE request to the /rest/api/3/user endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
x |
|
username |
String |
This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details. |
||
key |
String |
This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Reset User Columns
<jira:delete-rest-api3-user-columns>
Resets the default issue table columns for the user to the system default. If accountId is not passed, the calling user’s default columns are reset.
Permissions required:
-
Administer Jira global permission, to set the columns on any user.
-
Permission to access Jira, to set the calling user’s columns.
This operation makes an HTTP DELETE request to the /rest/api/3/user/columns endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
||
username |
String |
This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete User Property
<jira:delete-rest-api3-user-properties-by-property-key>
Deletes a property from a user. Note: This operation does not access the user properties created and maintained in Jira.
Permissions required:
-
Administer Jira global permission, to delete a property from any user.
-
Access to Jira, to delete a property from the calling user’s record.
This operation makes an HTTP DELETE request to the /rest/api/3/user/properties/{propertyKey} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Property Key |
String |
The key of the user’s property. |
x |
|
Account Id |
String |
The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
||
User Key |
String |
This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details. |
||
username |
String |
This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Webhook By Id
<jira:delete-rest-api3-webhook>
Removes webhooks by ID. Only webhooks registered by the calling Connect app are removed. If webhooks created by other apps are specified, they are ignored.
Permissions required:
Only Connect apps can use this operation.
This operation makes an HTTP DELETE request to the /rest/api/3/webhook endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Workflow Transition Property
<jira:delete-rest-api3-workflow-transitions-properties-by-transition-id>
Deletes a property from a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see Transition properties and Workflow properties.
Permissions required:
Administer Jira global permission
This operation makes an HTTP DELETE request to the /rest/api/3/workflow/transitions/{transitionId}/properties endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Transition Id |
Number |
The ID of the transition. To get the ID, view the workflow in text mode in the Jira admin settings. The ID is shown next to the transition. |
x |
|
key |
String |
The name of the transition property to delete, also known as the name of the property. |
x |
|
Workflow Name |
String |
The name of the workflow that the transition belongs to. |
x |
|
Workflow Mode |
Enumeration, one of:
|
The workflow status. Set to |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Workflow Scheme
<jira:delete-rest-api3-workflowscheme-by-id>
Deletes a workflow scheme. Note that a workflow scheme cannot be deleted if it is active (that is, being used by at least one project).
Permissions required:
Administer Jira global permission
This operation makes an HTTP DELETE request to the /rest/api/3/workflowscheme/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the workflow scheme. Find this ID by editing the desired workflow scheme in Jira. The ID is shown in the URL as |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Default Workflow
<jira:delete-rest-api3-workflowscheme-default-by-id>
Resets the default workflow for a workflow scheme. That is, the default workflow is set to Jira’s system workflow (the jira workflow). Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true and a draft workflow scheme is created or updated with the default workflow reset. The draft workflow scheme can be published in Jira.
Permissions required:
Administer Jira global permission
This operation makes an HTTP DELETE request to the /rest/api/3/workflowscheme/{id}/default endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the workflow scheme. |
x |
|
Update Draft If Needed |
Boolean |
Set to true to create or update the draft of a workflow scheme and delete the mapping from the draft, when the workflow scheme cannot be edited. Defaults to |
false |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Workflow Scheme Draft
<jira:delete-rest-api3-workflowscheme-draft-by-id>
Deletes a draft workflow scheme.
Permissions required:
Administer Jira global permission
This operation makes an HTTP DELETE request to the /rest/api/3/workflowscheme/{id}/draft endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the active workflow scheme that the draft was created from. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Draft Default Workflow
<jira:delete-rest-api3-workflowscheme-draft-default-by-id>
Resets the default workflow for a workflow scheme’s draft. That is, the default workflow is set to Jira’s system workflow (the jira workflow).
Permissions required:
Administer Jira global permission
This operation makes an HTTP DELETE request to the /rest/api/3/workflowscheme/{id}/draft/default endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the workflow scheme that the draft belongs to. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Workflow Scheme Draft Issue Type
<jira:delete-rest-api3-workflowscheme-draft-issuetype-by-id-issue-type>
Deletes the issue type-workflow mapping for an issue type in a workflow scheme’s draft.
Permissions required:
Administer Jira global permission
This operation makes an HTTP DELETE request to the /rest/api/3/workflowscheme/{id}/draft/issuetype/{issueType} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the workflow scheme that the draft belongs to. |
x |
|
Issue Type |
String |
The ID of the issue type. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Draft Workflow Mapping
<jira:delete-rest-api3-workflowscheme-draft-workflow-by-id>
Deletes the workflow-issue type mapping for a workflow in a workflow scheme’s draft.
Permissions required:
Administer Jira global permission
This operation makes an HTTP DELETE request to the /rest/api/3/workflowscheme/{id}/draft/workflow endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the workflow scheme that the draft belongs to. |
x |
|
Workflow Name |
String |
The name of the workflow. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Workflow Scheme Issue Type
<jira:delete-rest-api3-workflowscheme-issuetype-by-id-issue-type>
Deletes the issue type-workflow mapping for an issue type in a workflow scheme. Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true and a draft workflow scheme is created or updated with the issue type-workflow mapping deleted. The draft workflow scheme can be published in Jira.
Permissions required:
Administer Jira global permission
This operation makes an HTTP DELETE request to the /rest/api/3/workflowscheme/{id}/issuetype/{issueType} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the workflow scheme. |
x |
|
Issue Type |
String |
The ID of the issue type. |
x |
|
Update Draft If Needed |
Boolean |
Set to true to create or update the draft of a workflow scheme and update the mapping in the draft, when the workflow scheme cannot be edited. Defaults to |
false |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Delete Workflow Mapping
<jira:delete-rest-api3-workflowscheme-workflow-by-id>
Deletes the workflow-issue type mapping for a workflow in a workflow scheme. Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true and a draft workflow scheme is created or updated with the workflow-issue type mapping deleted. The draft workflow scheme can be published in Jira.
Permissions required:
Administer Jira global permission
This operation makes an HTTP DELETE request to the /rest/api/3/workflowscheme/{id}/workflow endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the workflow scheme. |
x |
|
Workflow Name |
String |
The name of the workflow. |
x |
|
Update Draft If Needed |
Boolean |
Set to true to create or update the draft of a workflow scheme and delete the mapping from the draft, when the workflow scheme cannot be edited. Defaults to |
false |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Addon Properties Resource delete Addon Property delete
<jira:delete-rest-atlassian-connect1-addons-properties-by-addon-key-property-key>
Deletes an app’s property.
Permissions required:
Only a Connect app whose key matches addonKey can make this request.
This operation makes an HTTP DELETE request to the /rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Addon Key |
String |
The key of the app, as defined in its descriptor. |
x |
|
Property Key |
String |
The key of the property. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Dynamic Modules Resource remove Modules delete
<jira:delete-rest-atlassian-connect1-app-module-dynamic>
Remove all or a list of modules registered by the calling app.
Permissions required:
Only Connect apps can make this request.
This operation makes an HTTP DELETE request to the /rest/atlassian-connect/1/app/module/dynamic endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Module Key |
Array of String |
The key of the module to remove. To include multiple module keys, provide multiple copies of this parameter. For example, |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Application Property
<jira:get-rest-api3-application-properties>
Returns all application properties or an application property. If you specify a value for the key parameter, then an application property is returned as an object (not in an array). Otherwise, an array of all editable application properties is returned. See [Set application property](#api-rest-api-3-application-properties-id-put) for descriptions of editable properties.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/application-properties endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
key |
String |
The key of the application property. |
||
Permission Level |
String |
The permission level of all items being returned in the list. |
||
Key Filter |
String |
When a |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Advanced Settings
<jira:get-rest-api3-application-properties-advanced-settings>
Returns the application properties that are accessible on the Advanced Settings page. To navigate to the Advanced Settings page in Jira, choose the Jira icon > Jira settings > System, General Configuration and then click Advanced Settings (in the upper right).
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/application-properties/advanced-settings endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get All Application Roles
<jira:get-rest-api3-applicationrole>
Returns all application roles. In Jira, application roles are managed using the Application access configuration page.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/applicationrole endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Application Role
<jira:get-rest-api3-applicationrole-by-key>
Returns an application role.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/applicationrole/{key} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
key |
String |
The key of the application role. Use the [Get all application roles](#api-rest-api-3-applicationrole-get) operation to get the key for each application role. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Attachment
<jira:get-rest-api3-attachment-by-id>
Returns the metadata for an attachment. Note that the attachment itself is not returned. This operation can be accessed anonymously.
Permissions required:
-
Browse projects project permission for the project that the issue is in.
-
If issue-level security is configured, issue-level security permission to view the issue.
This operation makes an HTTP GET request to the /rest/api/3/attachment/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
The ID of the attachment. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Expand Attachment For Humans
<jira:get-rest-api3-attachment-expand-human-by-id>
Returns the metadata for the contents of an attachment, if it is an archive, and metadata for the attachment itself. For example, if the attachment is a ZIP archive, then information about the files in the archive is returned and metadata for the ZIP archive.
Currently, only the ZIP archive format is supported. Use this operation to retrieve data that is presented to the user, as this operation returns the metadata for the attachment itself, such as the attachment’s ID and name. Otherwise, use [Get contents metadata for an expanded attachment](#api-rest-api-3-attachment-id-expand-raw-get), which only returns the metadata for the attachment’s contents.
This operation can be accessed anonymously.
Permissions required:
For the issue containing the attachment:
-
Browse projects project permission for the project that the issue is in.
-
If issue-level security is configured, issue-level security permission to view the issue.
This operation makes an HTTP GET request to the /rest/api/3/attachment/{id}/expand/human endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
The ID of the attachment. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Expand Attachment For Machines
<jira:get-rest-api3-attachment-expand-raw-by-id>
Returns the metadata for the contents of an attachment, if it is an archive. For example, if the attachment is a ZIP archive, then information about the files in the archive is returned. Currently, only the ZIP archive format is supported. Use this operation if you are processing the data without presenting it to the user, as this operation only returns the metadata for the contents of the attachment. Otherwise, to retrieve data to present to the user, use [Get all metadata for an expanded attachment](#api-rest-api-3-attachment-id-expand-human-get) which also returns the metadata for the attachment itself, such as the attachment’s ID and name. This operation can be accessed anonymously.
Permissions required:
For the issue containing the attachment:
-
Browse projects project permission for the project that the issue is in.
-
If issue-level security is configured, issue-level security permission to view the issue.
This operation makes an HTTP GET request to the /rest/api/3/attachment/{id}/expand/raw endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
The ID of the attachment. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Attachment Meta
<jira:get-rest-api3-attachment-meta>
Returns the attachment settings, that is, whether attachments are enabled and the maximum attachment size allowed. Note that there are also project permissions that restrict whether users can create and delete attachments. This operation can be accessed anonymously.
Permissions required:
None.
This operation makes an HTTP GET request to the /rest/api/3/attachment/meta endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Audit Records
<jira:get-rest-api3-auditing-record>
Returns a list of audit records. The list can be filtered to include items:
-
containing a string in at least one field. For example, providing up will return all audit records where one or more fields contains words such as update.
-
created on or after a date and time.
-
created on or before a date and time.
-
created during a time period.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/auditing/record endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
offset |
Number |
The number of records to skip before returning the first result. |
0 |
|
limit |
Number |
The maximum number of results to return. |
1000 |
|
filter |
String |
The query string. |
||
from |
String |
The date and time on or after which returned audit records must have been created. If |
||
to |
String |
The date and time on or before which returned audit results must have been created. If |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get All System Avatars
<jira:get-rest-api3-avatar-system-by-type>
Returns a list of system avatar details by owner type, where the owner types are issue type, project, or user. This operation can be accessed anonymously.
Permissions required:
None.
This operation makes an HTTP GET request to the /rest/api/3/avatar/{type}/system endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
type |
Enumeration, one of:
|
The avatar type. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Comment Property Keys
<jira:get-rest-api3-comment-properties-by-comment-id>
Returns the keys of all the properties of a comment. This operation can be accessed anonymously.
Permissions required:
-
Browse projects project permission for the project.
-
If issue-level security is configured, issue-level security permission to view the issue.
-
If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.
This operation makes an HTTP GET request to the /rest/api/3/comment/{commentId}/properties endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Comment Id |
String |
The ID of the comment. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Comment Property
<jira:get-rest-api3-comment-properties-by-comment-id-property-key>
Returns the value of a comment property. This operation can be accessed anonymously.
Permissions required:
-
Browse projects project permission for the project.
-
If issue-level security is configured, issue-level security permission to view the issue.
-
If the comment has visibility restrictions, belongs to the group or has the role visibility is restricted to.
This operation makes an HTTP GET request to the /rest/api/3/comment/{commentId}/properties/{propertyKey} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Comment Id |
String |
The ID of the comment. |
x |
|
Property Key |
String |
The key of the property. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Component
<jira:get-rest-api3-component-by-id>
Returns a component. This operation can be accessed anonymously.
Permissions required:
Browse projects project permission for project containing the component.
This operation makes an HTTP GET request to the /rest/api/3/component/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
The ID of the component. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Component Related Issues
<jira:get-rest-api3-component-related-issue-counts-by-id>
Returns the counts of issues assigned to the component. This operation can be accessed anonymously.
Permissions required:
None.
This operation makes an HTTP GET request to the /rest/api/3/component/{id}/relatedIssueCounts endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
The ID of the component. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Configuration
<jira:get-rest-api3-configuration>
Returns the global settings in Jira. These settings determine whether optional features (for example, subtasks, time tracking, and others) are enabled. If time tracking is enabled, this operation also returns the time tracking configuration. This operation can be accessed anonymously.
Permissions required:
None.
This operation makes an HTTP GET request to the /rest/api/3/configuration endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Selected Time Tracking Implementation
<jira:get-rest-api3-configuration-timetracking>
Returns the time tracking provider that is currently selected. Note that if time tracking is disabled, then a successful but empty response is returned.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/configuration/timetracking endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Available Time Tracking Implementations
<jira:get-rest-api3-configuration-timetracking-list>
Returns all time tracking providers. By default, Jira only has one time tracking provider: JIRA provided time tracking. However, you can install other time tracking providers via apps from the Atlassian Marketplace. For more information on time tracking providers, see the documentation for the Time Tracking Provider module.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/configuration/timetracking/list endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Shared Time Tracking Configuration
<jira:get-rest-api3-configuration-timetracking-options>
Returns the time tracking settings. This includes settings such as the time format, default time unit, and others. For more information, see Configuring time tracking.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/configuration/timetracking/options endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Options For Field
<jira:get-rest-api3-custom-field-option-by-field-id>
This operation is deprecated and becomes unavailable on 8 May 2021. Use Get custom field options (context) instead. See Deprecation of custom field options for details.
Returns a paginated list of options and, where the custom select field is of the type Select List (cascading), cascading options for custom select fields. Cascading options are included in the item count when determining pagination. Only options from the global context are returned. Note that this operation only works for issue field select list options created in Jira or using operations from the [Issue custom field options](#api-group-Issue-custom-field-options) resource, it cannot be used with issue field select list options created by Connect apps.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/customField/{fieldId}/option endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Field Id |
Number |
The ID of the custom field. Note: This is the numeric part of the of the field ID. For example, for a field with the ID customfield\_10075 use 10075. |
x |
|
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
1000 |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get All Dashboards
<jira:get-rest-api3-dashboard>
Returns a list of dashboards owned by or shared with the user. The list may be filtered to include only favorite or owned dashboards. This operation can be accessed anonymously.
Permissions required:
None.
This operation makes an HTTP GET request to the /rest/api/3/dashboard endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
filter |
Enumeration, one of:
|
The filter applied to the list of dashboards. Valid values are: * |
||
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
20 |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Dashboard
<jira:get-rest-api3-dashboard-by-id>
Returns a dashboard. This operation can be accessed anonymously.
Permissions required:
None.
However, to get a dashboard, the dashboard must be shared with the user or the user must own it. Note, users with the Administer Jira global permission are considered owners of the System dashboard. The System dashboard is considered to be shared with all other users.
This operation makes an HTTP GET request to the /rest/api/3/dashboard/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
The ID of the dashboard. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Dashboard Item Property Keys
<jira:get-rest-api3-dashboard-items-properties-by-dashboard-id-item-id>
Returns the keys of all properties for a dashboard item. This operation can be accessed anonymously.
Permissions required:
The user must be the owner of the dashboard or be shared the dashboard. Note, users with the Administer Jira global permission are considered owners of the System dashboard. The System dashboard is considered to be shared with all other users.
This operation makes an HTTP GET request to the /rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Dashboard Id |
String |
The ID of the dashboard. |
x |
|
Item Id |
String |
The ID of the dashboard item. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Dashboard Item Property
<jira:get-rest-api3-dashboard-items-properties-by-dashboard-id-item-id-property-key>
Returns the key and value of a dashboard item property. A dashboard item enables an app to add user-specific information to a user dashboard. Dashboard items are exposed to users as gadgets that users can add to their dashboards. For more information on how users do this, see Adding and customizing gadgets.
When an app creates a dashboard item it registers a callback to receive the dashboard item ID. The callback fires whenever the item is rendered or, where the item is configurable, the user edits the item. The app then uses this resource to store the item’s content or configuration details. For more information on working with dashboard items, see Building a dashboard item for a JIRA Connect add-on and the Dashboard Item documentation. There is no resource to set or get dashboard items. This operation can be accessed anonymously.
Permissions required:
The user must be the owner of the dashboard or be shared the dashboard. Note, users with the Administer Jira global permission are considered owners of the System dashboard. The System dashboard is considered to be shared with all other users.
This operation makes an HTTP GET request to the /rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Dashboard Id |
String |
The ID of the dashboard. |
x |
|
Item Id |
String |
The ID of the dashboard item. |
x |
|
Property Key |
String |
The key of the dashboard item property. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Dashboards Paginated
<jira:get-rest-api3-dashboard-search>
Returns a paginated list of dashboards. This operation is similar to [Get dashboards](#api-rest-api-3-dashboard-get) except that the results can be refined to include dashboards that have specific attributes. For example, dashboards with a particular name. When multiple attributes are specified only filters matching all attributes are returned. This operation can be accessed anonymously.
Permissions required:
The following dashboards that match the query parameters are returned:
-
Dashboards owned by the user. Not returned for anonymous users.
-
Dashboards shared with a group that the user is a member of. Not returned for anonymous users.
-
Dashboards shared with a private project that the user can browse. Not returned for anonymous users.
-
Dashboards shared with a public project.
-
Dashboards shared with the public.
This operation makes an HTTP GET request to the /rest/api/3/dashboard/search endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Dashboard Name |
String |
String used to perform a case-insensitive partial match with |
||
Account Id |
String |
User account ID used to return dashboards with the matching |
||
owner |
String |
This parameter is deprecated because of privacy changes. Use |
||
groupname |
String |
Group name used to returns dashboards that are shared with a group that matches |
||
Project Id |
Number |
Project ID used to returns dashboards that are shared with a project that matches |
||
Order By |
Enumeration, one of:
|
Order the results by a field:
|
NAME |
|
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
50 |
|
expand |
String |
Use
|
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Fields
<jira:get-rest-api3-field>
Returns system and custom issue fields according to the following rules:
-
Fields that cannot be added to the issue navigator are always returned.
-
Fields that cannot be placed on an issue screen are always returned.
-
Fields that depend on global Jira settings are only returned if the setting is enabled. That is, timetracking fields, subtasks, votes, and watches.
-
For all other fields, this operation only returns the fields that the user has permission to view (that is, the field is used in at least one project that the user has Browse Projects project permission for.) This operation can be accessed anonymously.
Permissions required:
None.
This operation makes an HTTP GET request to the /rest/api/3/field endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Contexts For Field
<jira:get-rest-api3-field-context-by-field-id>
Returns a paginated list of contexts for a custom field. Contexts can be returned as follows:
-
With no other parameters set, all contexts.
-
By defining
idonly, all contexts from the list of IDs. -
By defining
isAnyIssueType, limit the list of contexts returned to either those that apply to all issue types (true) or those that apply to only a subset of issue types (false) -
By defining
isGlobalContext, limit the list of contexts return to either those that apply to all projects (global contexts) (true) or those that apply to only a subset of projects (false).
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/field/{fieldId}/context endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Field Id |
String |
The ID of the custom field. |
x |
|
Is Any Issue Type |
Boolean |
Whether to return contexts that apply to all issue types. |
false |
|
Is Global Context |
Boolean |
Whether to return contexts that apply to all projects. |
false |
|
Context Id |
Array of Number |
The list of context IDs. To include multiple contexts, separate IDs with ampersand: |
||
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
50 |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Default Values
<jira:get-rest-api3-field-context-default-value-by-field-id>
Returns a paginated list of defaults for a custom field. The results can be filtered by contextId, otherwise all values are returned. If no defaults are set for a context, nothing is returned. The returned object depends on type of the custom field:
-
CustomFieldContextDefaultValueSingleOption(typeoption.single) for single choice select lists and radio buttons. -
CustomFieldContextDefaultValueMultipleOption(typeoption.multiple) for multiple choice select lists and checkboxes. -
CustomFieldContextDefaultValueCascadingOption(typeoption.cascading) for cascading select lists.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/field/{fieldId}/context/defaultValue endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Field Id |
String |
The ID of the custom field. |
x |
|
Context Id |
Array of Number |
The IDs of the contexts. |
||
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
50 |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Issue Type Mappings For Contexts
<jira:get-rest-api3-field-context-issue-type-mapping-by-field-id>
Returns a paginated list of context to issue type mappings for a custom field. Mappings are returned for all contexts or a list of contexts. Mappings are ordered first by context ID and then by issue type ID.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/field/{fieldId}/context/issueTypeMapping endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Field Id |
String |
The ID of the custom field. |
x |
|
Context Id |
Array of Number |
The ID of the context. To include multiple contexts, provide an ampersand-separated list. For example, |
||
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
50 |
|
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Options For Context
<jira:get-rest-api3-field-context-option-by-field-id-context-id>
Returns a paginated list of all custom field option for a context. Options are returned first then cascading options, in the order they display in Jira. This operation works for custom field options created in Jira or the operations from this resource. To work with issue field select list options created for Connect apps use the [Issue custom field options (apps)](#api-group-issue-custom-field-options—apps-) operations.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/field/{fieldId}/context/{contextId}/option endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Field Id |
String |
The ID of the custom field. |
x |
|
Context Id |
Number |
The ID of the context. |
x |
|
Option Id |
Number |
The ID of the option. |
||
Only Options |
Boolean |
Whether only options are returned. |
false |
|
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
100 |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Project Context Mapping
<jira:get-rest-api3-field-context-projectmapping-by-field-id>
Returns a paginated list of context to project mappings for a custom field. The result can be filtered by contextId, or otherwise all mappings are returned. Invalid IDs are ignored.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/field/{fieldId}/context/projectmapping endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Field Id |
String |
The ID of the custom field. |
x |
|
Context Id |
Array of Number |
The list of context IDs. To include multiple context, separate IDs with ampersand: |
||
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
50 |
|
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get All Issue Field Options
<jira:get-rest-api3-field-option-by-field-key>
Returns a paginated list of all the options of a select list issue field. A select list issue field is a type of issue field that enables a user to select a value from a list of options. Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the [Issue custom field options](#api-group-Issue-custom-field-options) resource.
Permissions required:
Administer Jira global permission
Jira permissions are not required for the app providing the field. This operation makes an HTTP GET request to the /rest/api/3/field/{fieldKey}/option endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Field Key |
String |
The field key is specified in the following format: $(app-key)_\_$(field-key). For example, example-add-on\_\_example-issue-field. To determine the
|
x |
|
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
50 |
|
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Issue Field Option
<jira:get-rest-api3-field-option-by-field-key-option-id>
Returns an option from a select list issue field. Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the [Issue custom field options](#api-group-Issue-custom-field-options) resource.
Permissions required:
Administer Jira global permission
Jira permissions are not required for the app providing the field. This operation makes an HTTP GET request to the /rest/api/3/field/{fieldKey}/option/{optionId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Field Key |
String |
The field key is specified in the following format: $(app-key)_\_$(field-key). For example, example-add-on\_\_example-issue-field. To determine the
|
x |
|
Option Id |
Number |
The ID of the option to be returned. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Selectable Issue Field Options
<jira:get-rest-api3-field-option-suggestions-edit-by-field-key>
Returns a paginated list of options for a select list issue field that can be viewed and selected by the user. Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the [Issue custom field options](#api-group-Issue-custom-field-options) resource.
Permissions required:
Permission to access Jira.
This operation makes an HTTP GET request to the /rest/api/3/field/{fieldKey}/option/suggestions/edit endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Field Key |
String |
The field key is specified in the following format: $(app-key)_\_$(field-key). For example, example-add-on\_\_example-issue-field. To determine the
|
x |
|
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
50 |
|
Project Id |
Number |
Filters the results to options that are only available in the specified project. |
||
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Visible Issue Field Options
<jira:get-rest-api3-field-option-suggestions-search-by-field-key>
Returns a paginated list of options for a select list issue field that can be viewed by the user. Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the [Issue custom field options](#api-group-Issue-custom-field-options) resource.
Permissions required:
Permission to access Jira.
This operation makes an HTTP GET request to the /rest/api/3/field/{fieldKey}/option/suggestions/search endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Field Key |
String |
The field key is specified in the following format: $(app-key)_\_$(field-key). For example, example-add-on\_\_example-issue-field. To determine the
|
x |
|
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
||
Project Id |
Number |
Filters the results to options that are only available in the specified project. |
||
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Screens For Field
<jira:get-rest-api3-field-screens-by-field-id>
Returns a paginated list of the screens a field is used in.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/field/{fieldId}/screens endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Field Id |
String |
The ID of the field to return screens for. |
x |
|
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
100 |
|
expand |
String |
Use |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Fields Paginated
<jira:get-rest-api3-field-search>
Returns a paginated list of fields for Classic Jira projects. The list can include:
-
all fields.
-
specific fields, by defining
id. -
fields that contain a string in the field name or description, by defining
query. -
specific fields that contain a string in the field name or description, by defining
idandquery. Only custom fields can be queried,typemust be set tocustom.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/field/search endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
50 |
|
type |
Array of Enumeration, one of:
|
The type of fields to search. |
||
id |
Array of String |
The IDs of the custom fields to return or, where |
||
query |
String |
String used to perform a case-insensitive partial match with field names or descriptions. |
||
Order By |
Enumeration, one of:
|
Order the results by a field:
|
||
expand |
String |
Use
|
||
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get All Field Configurations
<jira:get-rest-api3-fieldconfiguration>
Returns a paginated list of all field configurations. Only field configurations used in classic projects are returned.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/fieldconfiguration endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
50 |
|
id |
Array of Number |
The list of field configuration IDs. To include multiple IDs, provide an ampersand-separated list. For example, |
||
Is Default |
Boolean |
If true returns the default field configuration only. |
false |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Field Configuration Items
<jira:get-rest-api3-fieldconfiguration-fields-by-id>
Returns a paginated list of all fields for a configuration. Only the fields from configurations used in classic projects are returned.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/fieldconfiguration/{id}/fields endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the field configuration. |
x |
|
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
50 |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get All Field Configuration Schemes
<jira:get-rest-api3-fieldconfigurationscheme>
Returns a paginated list of field configuration schemes. Only field configuration schemes used in classic projects are returned.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/fieldconfigurationscheme endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
50 |
|
id |
Array of Number |
The list of field configuration scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Field Configuration Scheme Mappings
<jira:get-rest-api3-fieldconfigurationscheme-mapping>
Returns a paginated list of field configuration issue type items. Only items used in classic projects are returned.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/fieldconfigurationscheme/mapping endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
50 |
|
Field Configuration Scheme Id |
Array of Number |
The list of field configuration scheme IDs. To include multiple field configuration schemes separate IDs with ampersand: |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Field Configuration Scheme Project Mapping
<jira:get-rest-api3-fieldconfigurationscheme-project>
Returns a paginated list of field configuration schemes and, for each scheme, a list of the projects that use it. The list is sorted by field configuration scheme ID. The first item contains the list of project IDs assigned to the default field configuration scheme. Only field configuration schemes used in classic projects are returned.
Permissions required:
Administer Jira global permission.
This operation makes an HTTP GET request to the /rest/api/3/fieldconfigurationscheme/project endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
50 |
|
Project Id |
Array of Number |
The list of project IDs. To include multiple projects, separate IDs with ampersand: |
x |
|
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Filter
<jira:get-rest-api3-filter-by-id>
Returns a filter. This operation can be accessed anonymously.
Permissions required:
None, however, the filter is only returned where it is:
-
owned by the user.
-
shared with a group that the user is a member of.
-
shared with a private project that the user has Browse projects project permission for.
-
shared with a public project.
-
shared with the public.
This operation makes an HTTP GET request to the /rest/api/3/filter/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the filter to return. |
x |
|
expand |
String |
Use
|
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Columns
<jira:get-rest-api3-filter-columns-by-id>
Returns the columns configured for a filter. The column configuration is used when the filter’s results are viewed in List View with the Columns set to Filter. This operation can be accessed anonymously.
Permissions required:
None, however, column details are only returned for:
-
filters owned by the user.
-
filters shared with a group that the user is a member of.
-
filters shared with a private project that the user has Browse projects project permission for.
-
filters shared with a public project.
-
filters shared with the public.
This operation makes an HTTP GET request to the /rest/api/3/filter/{id}/columns endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the filter. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Default Share Scope
<jira:get-rest-api3-filter-default-share-scope>
Returns the default sharing settings for new filters and dashboards for a user.
Permissions required:
Permission to access Jira.
This operation makes an HTTP GET request to the /rest/api/3/filter/defaultShareScope endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Favourite Filters
<jira:get-rest-api3-filter-favourite>
Returns the visible favorite filters of the user. This operation can be accessed anonymously.
Permissions required:
A favorite filter is only visible to the user where the filter is:
-
owned by the user.
-
shared with a group that the user is a member of.
-
shared with a private project that the user has Browse projects project permission for.
-
shared with a public project.
-
shared with the public. For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.
This operation makes an HTTP GET request to the /rest/api/3/filter/favourite endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
expand |
String |
Use
|
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get My Filters
<jira:get-rest-api3-filter-my>
Returns the filters owned by the user. If includeFavourites is true, the user’s visible favorite filters are also returned.
Permissions required:
Permission to access Jira, however, a favorite filters is only visible to the user where the filter is:
-
owned by the user.
-
shared with a group that the user is a member of.
-
shared with a private project that the user has Browse projects project permission for.
-
shared with a public project.
-
shared with the public. For example, if the user favorites a public filter that is subsequently made private that filter is not returned by this operation.
This operation makes an HTTP GET request to the /rest/api/3/filter/my endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
expand |
String |
Use
|
||
Include Favourites |
Boolean |
Include the user’s favorite filters in the response. |
false |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Share Permissions
<jira:get-rest-api3-filter-permission-by-id>
Returns the share permissions for a filter. A filter can be shared with groups, projects, all logged-in users, or the public. Sharing with all logged-in users or the public is known as a global share permission. This operation can be accessed anonymously.
Permissions required:
None, however, share permissions are only returned for:
-
filters owned by the user.
-
filters shared with a group that the user is a member of.
-
filters shared with a private project that the user has Browse projects project permission for.
-
filters shared with a public project.
-
filters shared with the public.
This operation makes an HTTP GET request to the /rest/api/3/filter/{id}/permission endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the filter. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Share Permission
<jira:get-rest-api3-filter-permission-by-id-permission-id>
Returns a share permission for a filter. A filter can be shared with groups, projects, all logged-in users, or the public. Sharing with all logged-in users or the public is known as a global share permission. This operation can be accessed anonymously.
Permissions required:
None, however, a share permission is only returned for:
-
filters owned by the user.
-
filters shared with a group that the user is a member of.
-
filters shared with a private project that the user has Browse projects project permission for.
-
filters shared with a public project.
-
filters shared with the public.
This operation makes an HTTP GET request to the /rest/api/3/filter/{id}/permission/{permissionId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the filter. |
x |
|
Permission Id |
Number |
The ID of the share permission. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Filters Paginated
<jira:get-rest-api3-filter-search>
Returns a paginated list of filters. Use this operation to get:
-
specific filters, by defining
idonly. -
filters that match all of the specified attributes. For example, all filters for a user with a particular word in their name. When multiple attributes are specified only filters matching all attributes are returned. This operation can be accessed anonymously.
Permissions required:
None, however, only the following filters that match the query parameters are returned:
-
filters owned by the user.
-
filters shared with a group that the user is a member of.
-
filters shared with a private project that the user has Browse projects project permission for.
-
filters shared with a public project.
-
filters shared with the public.
This operation makes an HTTP GET request to the /rest/api/3/filter/search endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Filter Name |
String |
String used to perform a case-insensitive partial match with |
||
Account Id |
String |
User account ID used to return filters with the matching |
||
owner |
String |
This parameter is deprecated because of privacy changes. Use |
||
groupname |
String |
Group name used to returns filters that are shared with a group that matches |
||
Project Id |
Number |
Project ID used to returns filters that are shared with a project that matches |
||
id |
Array of Number |
The list of filter IDs. To include multiple IDs, provide an ampersand-separated list. For example, |
||
Order By |
Enumeration, one of:
|
Order the results by a field:
|
NAME |
|
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
50 |
|
expand |
String |
Use
|
||
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Bulk Get Groups
<jira:get-rest-api3-group-bulk>
Returns a paginated list of groups.
Permissions required:
Browse users and groups global permission
This operation makes an HTTP GET request to the /rest/api/3/group/bulk endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
50 |
|
Group Id |
Array of String |
The ID of a group. To specify multiple IDs, pass multiple |
||
Group Name |
Array of String |
The name of a group. To specify multiple names, pass multiple |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Users From Group
<jira:get-rest-api3-group-member>
Returns a paginated list of all users in a group. Note that users are ordered by username, however the username is not returned in the results due to privacy reasons.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/group/member endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
groupname |
String |
The name of the group. |
x |
|
Include Inactive Users |
Boolean |
Include inactive users. |
false |
|
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
50 |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Find Groups
<jira:get-rest-api3-groups-picker>
Returns a list of groups whose names contain a query string. A list of group names can be provided to exclude groups from the results. The primary use case for this resource is to populate a group picker suggestions list. To this end, the returned object includes the html field where the matched query term is highlighted in the group name with the HTML strong tag. Also, the groups list is wrapped in a response object that contains a header for use in the picker, specifically Showing X of Y matching groups. The list returns with the groups sorted. If no groups match the list criteria, an empty list is returned. This operation can be accessed anonymously.
Permissions required:
Browse projects project permission. Anonymous calls and calls by users without the required permission return an empty list.
This operation makes an HTTP GET request to the /rest/api/3/groups/picker endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
This parameter is deprecated, setting it does not affect the results. To find groups containing a particular user, use [Get user groups](#api-rest-api-3-user-groups-get). |
||
query |
String |
The string to find in group names. |
||
exclude |
Array of String |
A group to exclude from the result. To exclude multiple groups, provide an ampersand-separated list. For example, |
||
Max Results |
Number |
The maximum number of groups to return. The maximum number of groups that can be returned is limited by the system property |
||
User Name |
String |
This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Find Users And Groups
<jira:get-rest-api3-groupuserpicker>
Returns a list of users and groups matching a string. The string is used:
-
for users, to find a case-insensitive match with display name and e-mail address. Note that if a user has hidden their email address in their user profile, partial matches of the email address will not find the user. An exact match is required.
-
for groups, to find a case-sensitive match with group name. For example, if the string tin is used, records with the display name Tina, email address sarah@tinplatetraining.com, and the group accounting would be returned. Optionally, the search can be refined to:
-
the projects and issue types associated with a custom field, such as a user picker.
The search can then be further refined to return only users and groups that have permission to view specific:-
projects.
-
issue types.
-
If multiple projects or issue types are specified, they must be a subset of those enabled for the custom field or no results are returned. For example, if a field is enabled for projects A, B, and C then the search could be limited to projects B and C. However, if the search is limited to projects B and D, nothing is returned.
The primary use case for this resource is to populate a picker field suggestion list with users or groups. To this end, the returned object includes an html field for each list. This field highlights the matched query term in the item name with the HTML strong tag. Also, each list is wrapped in a response object that contains a header for use in a picker, specifically Showing X of Y matching groups. This operation can be accessed anonymously.
Permissions required:
Browse users and groups global permission
This operation makes an HTTP GET request to the /rest/api/3/groupuserpicker endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
query |
String |
The search string. |
x |
|
Max Results |
Number |
The maximum number of items to return in each list. |
50 |
|
Show Avatar |
Boolean |
Whether the user avatar should be returned. If an invalid value is provided, the default value is used. |
false |
|
Field Id |
String |
The custom field ID of the field this request is for. |
||
Project Id |
Array of String |
The ID of a project that returned users and groups must have permission to view. To include multiple projects, provide an ampersand-separated list. For example, |
||
Issue Type Id |
Array of String |
The ID of an issue type that returned users and groups must have permission to view. To include multiple issue types, provide an ampersand-separated list. For example, |
||
Avatar Size |
Enumeration, one of:
|
The size of the avatar to return. If an invalid value is provided, the default value is used. |
XSMALL |
|
Case Insensitive |
Boolean |
Whether the search for groups should be case insensitive. |
false |
|
Exclude Connect Addons |
Boolean |
Whether Connect app users and groups should be excluded from the search results. If an invalid value is provided, the default value is used. |
false |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Issue
<jira:get-rest-api3-issue-by-issue-id-or-key>
Returns the details for an issue. The issue is identified by its ID or key, however, if the identifier doesn’t match an issue, a case-insensitive search and check for moved issues is performed. If a matching issue is found its details are returned, a 302 or other redirect is not returned. The issue key returned in the response is the key of the issue found. This operation can be accessed anonymously.
Permissions required:
-
Browse projects project permission for the project that the issue is in.
-
If issue-level security is configured, issue-level security permission to view the issue.
This operation makes an HTTP GET request to the /rest/api/3/issue/{issueIdOrKey} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Id Or Key |
String |
The ID or key of the issue. |
x |
|
fields |
Array of String |
A list of fields to return for the issue. This parameter accepts a comma-separated list. Use it to retrieve a subset of fields. Allowed values:
Examples:
This parameter can be specified multiple times, for example, |
||
Fields By Keys |
Boolean |
Whether fields in |
false |
|
expand |
String |
Use
|
||
properties |
Array of String |
A list of issue properties to return for the issue. This parameter accepts a comma-separated list. Allowed values:
Examples:
This parameter can be specified multiple times, for example, |
||
Update History |
Boolean |
Whether the project in which the issue is created is added to the user’s Recently viewed project list, as shown under Projects in Jira. This also populates the [JQL issues search](#api-rest-api-3-search-get) |
false |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Change Logs
<jira:get-rest-api3-issue-changelog-by-issue-id-or-key>
Returns a paginated list of all changelogs for an issue sorted by date, starting from the oldest. This operation can be accessed anonymously.
Permissions required:
-
Browse projects project permission for the project that the issue is in.
-
If issue-level security is configured, issue-level security permission to view the issue.
This operation makes an HTTP GET request to the /rest/api/3/issue/{issueIdOrKey}/changelog endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Id Or Key |
String |
The ID or key of the issue. |
x |
|
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
100 |
|
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Comments
<jira:get-rest-api3-issue-comment-by-issue-id-or-key>
Returns all comments for an issue. This operation can be accessed anonymously.
Permissions required:
Comments are included in the response where the user has:
-
Browse projects project permission for the project containing the comment.
-
If issue-level security is configured, issue-level security permission to view the issue.
-
If the comment has visibility restrictions, belongs to the group or has the role visibility is role visibility is restricted to.
This operation makes an HTTP GET request to the /rest/api/3/issue/{issueIdOrKey}/comment endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Id Or Key |
String |
The ID or key of the issue. |
x |
|
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
50 |
|
Order By |
Enumeration, one of:
|
Order the results by a field. Accepts created to sort comments by their created date. |
||
expand |
String |
Use |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Comment
<jira:get-rest-api3-issue-comment-by-issue-id-or-key-id>
Returns a comment. This operation can be accessed anonymously.
Permissions required:
-
Browse projects project permission for the project containing the comment.
-
If issue-level security is configured, issue-level security permission to view the issue.
-
If the comment has visibility restrictions, the user belongs to the group or has the role visibility is restricted to.
This operation makes an HTTP GET request to the /rest/api/3/issue/{issueIdOrKey}/comment/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Id Or Key |
String |
The ID or key of the issue. |
x |
|
id |
String |
The ID of the comment. |
x |
|
expand |
String |
Use |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Create Issue Meta
<jira:get-rest-api3-issue-createmeta>
Returns details of projects, issue types within projects, and, when requested, the create screen fields for each issue type for the user. Use the information to populate the requests in [ Create issue](#api-rest-api-3-issue-post) and [Create issues](#api-rest-api-3-issue-bulk-post). The request can be restricted to specific projects or issue types using the query parameters. The response will contain information for the valid projects, issue types, or project and issue type combinations requested. Note that invalid project, issue type, or project and issue type combinations do not generate errors. This operation can be accessed anonymously.
Permissions required:
Create issues project permission in the requested projects.
This operation makes an HTTP GET request to the /rest/api/3/issue/createmeta endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Project Ids |
Array of String |
List of project IDs. This parameter accepts a comma-separated list. Multiple project IDs can also be provided using an ampersand-separated list. For example, |
||
Project Keys |
Array of String |
List of project keys. This parameter accepts a comma-separated list. Multiple project keys can also be provided using an ampersand-separated list. For example, |
||
Issuetype Ids |
Array of String |
List of issue type IDs. This parameter accepts a comma-separated list. Multiple issue type IDs can also be provided using an ampersand-separated list. For example, |
||
Issuetype Names |
Array of String |
List of issue type names. This parameter accepts a comma-separated list. Multiple issue type names can also be provided using an ampersand-separated list. For example, |
||
expand |
String |
Use |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Edit Issue Meta
<jira:get-rest-api3-issue-editmeta-by-issue-id-or-key>
Returns the edit screen fields for an issue that are visible to and editable by the user. Use the information to populate the requests in [Edit issue](#api-rest-api-3-issue-issueIdOrKey-put). Connect app users with admin permissions (from user permissions and app scopes) can return additional details using:
-
overrideScreenSecurityReturns hidden fields. -
overrideEditableFlagReturns uneditable fields. For example, where an issue has a workflow status of closed none of its fields are editable. This operation can be accessed anonymously.
Permissions required:
-
Browse projects project permission for the project that the issue is in.
-
If issue-level security is configured, issue-level security permission to view the issue. Note: For any fields to be editable the user must have the Edit issues project permission for the issue.
This operation makes an HTTP GET request to the /rest/api/3/issue/{issueIdOrKey}/editmeta endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Id Or Key |
String |
The ID or key of the issue. |
x |
|
Override Screen Security |
Boolean |
Whether hidden fields should be returned. Available to connect app users with admin permissions. |
false |
|
Override Editable Flag |
Boolean |
Whether non-editable fields should be returned. Available to connect app users with admin permissions. |
false |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Issue Link
<jira:get-rest-api3-issue-link-by-link-id>
Returns an issue link. This operation can be accessed anonymously.
Permissions required:
-
Browse project project permission for all the projects containing the linked issues.
-
If issue-level security is configured, permission to view both of the issues.
This operation makes an HTTP GET request to the /rest/api/3/issueLink/{linkId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Link Id |
String |
The ID of the issue link. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Issue Link Types
<jira:get-rest-api3-issue-link-type>
Returns a list of all issue link types. To use this operation, the site must have issue linking enabled. This operation can be accessed anonymously.
Permissions required:
Browse projects project permission for a project in the site.
This operation makes an HTTP GET request to the /rest/api/3/issueLinkType endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Issue Link Type
<jira:get-rest-api3-issue-link-type-by-issue-link-type-id>
Returns an issue link type. To use this operation, the site must have issue linking enabled. This operation can be accessed anonymously.
Permissions required:
Browse projects project permission for a project in the site.
This operation makes an HTTP GET request to the /rest/api/3/issueLinkType/{issueLinkTypeId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Link Type Id |
String |
The ID of the issue link type. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Issue Picker Resource
<jira:get-rest-api3-issue-picker>
Returns lists of issues matching a query string. Use this resource to provide auto-completion suggestions when the user is looking for an issue using a word or string. This operation returns two lists:
-
History Searchwhich includes issues from the user’s history of created, edited, or viewed issues that contain the string in thequeryparameter. -
Current Searchwhich includes issues that match the JQL expression incurrentJQLand contain the string in thequeryparameter.
This operation can be accessed anonymously.
Permissions required:
None.
This operation makes an HTTP GET request to the /rest/api/3/issue/picker endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
query |
String |
A string to match against text fields in the issue such as title, description, or comments. |
||
Current JQL |
String |
A JQL query defining a list of issues to search for the query term. Note that |
||
Current Issue Key |
String |
The key of an issue to exclude from search results. For example, the issue the user is viewing when they perform this query. |
||
Current Project Id |
String |
The ID of a project that suggested issues must belong to. |
||
Show Sub Tasks |
Boolean |
Indicate whether to include subtasks in the suggestions list. |
false |
|
Show Sub Task Parent |
Boolean |
When |
false |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Issue Property Keys
<jira:get-rest-api3-issue-properties-by-issue-id-or-key>
Returns the URLs and keys of an issue’s properties. This operation can be accessed anonymously.
Permissions required:
Property details are only returned where the user has:
-
Browse projects project permission for the project containing the issue.
-
If issue-level security is configured, issue-level security permission to view the issue.
This operation makes an HTTP GET request to the /rest/api/3/issue/{issueIdOrKey}/properties endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Id Or Key |
String |
The key or ID of the issue. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Issue Property
<jira:get-rest-api3-issue-properties-by-issue-id-or-key-property-key>
Returns the key and value of an issue’s property. This operation can be accessed anonymously.
Permissions required:
-
Browse projects project permission for the project containing the issue.
-
If issue-level security is configured, issue-level security permission to view the issue.
This operation makes an HTTP GET request to the /rest/api/3/issue/{issueIdOrKey}/properties/{propertyKey} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Id Or Key |
String |
The key or ID of the issue. |
x |
|
Property Key |
String |
The key of the property. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Remote Issue Links
<jira:get-rest-api3-issue-remotelink-by-issue-id-or-key>
Returns the remote issue links for an issue. When a remote issue link global ID is provided the record with that global ID is returned, otherwise all remote issue links are returned. Where a global ID includes reserved URL characters these must be escaped in the request. For example, pass system=http://www.mycompany.com/support&id=1 as system%3Dhttp%3A%2F%2Fwww.mycompany.com%2Fsupport%26id%3D1. This operation requires issue linking to be active. This operation can be accessed anonymously.
Permissions required:
-
Browse projects project permission for the project that the issue is in.
-
If issue-level security is configured, issue-level security permission to view the issue.
This operation makes an HTTP GET request to the /rest/api/3/issue/{issueIdOrKey}/remotelink endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Id Or Key |
String |
The ID or key of the issue. |
x |
|
Global Id |
String |
The global ID of the remote issue link. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Remote Issue Link By Id
<jira:get-rest-api3-issue-remotelink-by-issue-id-or-key-link-id>
Returns a remote issue link for an issue. This operation requires issue linking to be active. This operation can be accessed anonymously.
Permissions required:
-
Browse projects project permission for the project that the issue is in.
-
If issue-level security is configured, issue-level security permission to view the issue.
This operation makes an HTTP GET request to the /rest/api/3/issue/{issueIdOrKey}/remotelink/{linkId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Id Or Key |
String |
The ID or key of the issue. |
x |
|
Link Id |
String |
The ID of the remote issue link. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Transitions
<jira:get-rest-api3-issue-transitions-by-issue-id-or-key>
Returns either all transitions or a transition that can be performed by the user on an issue, based on the issue’s status. Note, if a request is made for a transition that does not exist or cannot be performed on the issue, given its status, the response will return any empty transitions list. This operation can be accessed anonymously.
Permissions required:
A list or transition is returned only when the user has:
-
Browse projects project permission for the project that the issue is in.
-
If issue-level security is configured, issue-level security permission to view the issue. However, if the user does not have the Transition issues project permission the response will not list any transitions.
This operation makes an HTTP GET request to the /rest/api/3/issue/{issueIdOrKey}/transitions endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Id Or Key |
String |
The ID or key of the issue. |
x |
|
expand |
String |
Use |
||
Transition Id |
String |
The ID of the transition. |
||
Skip Remote Only Condition |
Boolean |
Whether transitions with the condition Hide From User Condition are included in the response. |
false |
|
Include Unavailable Transitions |
Boolean |
Whether details of transitions that fail a condition are included in the response |
false |
|
Sort By Ops Bar And Status |
Boolean |
Whether the transitions are sorted by ops-bar sequence value first then category order (Todo, In Progress, Done) or only by ops-bar sequence value. |
false |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Votes
<jira:get-rest-api3-issue-votes-by-issue-id-or-key>
Returns details about the votes on an issue. This operation requires the Allow users to vote on issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application options for details. This operation can be accessed anonymously.
Permissions required:
-
Browse projects project permission for the project that the issue is ini
-
If issue-level security is configured, issue-level security permission to view the issue. Note that users with the necessary permissions for this operation but without the View voters and watchers project permissions are not returned details in the
votersfield.
This operation makes an HTTP GET request to the /rest/api/3/issue/{issueIdOrKey}/votes endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Id Or Key |
String |
The ID or key of the issue. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Issue Watchers
<jira:get-rest-api3-issue-watchers-by-issue-id-or-key>
Returns the watchers for an issue. This operation requires the Allow users to watch issues option to be ON. This option is set in General configuration for Jira. See Configuring Jira application options for details. This operation can be accessed anonymously.
Permissions required:
-
Browse projects project permission for the project that the issue is ini
-
If issue-level security is configured, issue-level security permission to view the issue.
-
To see details of users on the watchlist other than themselves, View voters and watchers project permission for the project that the issue is in.
This operation makes an HTTP GET request to the /rest/api/3/issue/{issueIdOrKey}/watchers endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Id Or Key |
String |
The ID or key of the issue. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Issue Worklog
<jira:get-rest-api3-issue-worklog-by-issue-id-or-key>
Returns worklogs for an issue, starting from the oldest worklog or from the worklog started on or after a date and time. Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking. This operation can be accessed anonymously.
Permissions required:
Workloads are only returned where the user has:
-
Browse projects project permission for the project that the issue is in.
-
If issue-level security is configured, issue-level security permission to view the issue.
-
If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
This operation makes an HTTP GET request to the /rest/api/3/issue/{issueIdOrKey}/worklog endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Id Or Key |
String |
The ID or key of the issue. |
x |
|
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
1048576 |
|
Started After |
Number |
The worklog start date and time, as a UNIX timestamp in milliseconds, after which worklogs are returned. |
||
expand |
String |
Use |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Worklog
<jira:get-rest-api3-issue-worklog-by-issue-id-or-key-id>
Returns a worklog. Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking. This operation can be accessed anonymously.
Permissions required:
-
Browse projects project permission for the project that the issue is in.
-
If issue-level security is configured, issue-level security permission to view the issue.
-
If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
This operation makes an HTTP GET request to the /rest/api/3/issue/{issueIdOrKey}/worklog/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Id Or Key |
String |
The ID or key of the issue. |
x |
|
id |
String |
The ID of the worklog. |
x |
|
expand |
String |
Use |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Worklog Property Keys
<jira:get-rest-api3-issue-worklog-properties-by-issue-id-or-key-worklog-id>
Returns the keys of all properties for a worklog. This operation can be accessed anonymously.
Permissions required:
-
Browse projects project permission for the project that the issue is in.
-
If issue-level security is configured, issue-level security permission to view the issue.
-
If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
This operation makes an HTTP GET request to the /rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Id Or Key |
String |
The ID or key of the issue. |
x |
|
Worklog Id |
String |
The ID of the worklog. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Worklog Property
<jira:get-rest-api3-issue-worklog-properties-by-issue-id-or-key-worklog-id-property-key>
Returns the value of a worklog property. This operation can be accessed anonymously.
Permissions required:
-
Browse projects project permission for the project that the issue is in.
-
If issue-level security is configured, issue-level security permission to view the issue.
-
If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
This operation makes an HTTP GET request to the /rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties/{propertyKey} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Id Or Key |
String |
The ID or key of the issue. |
x |
|
Worklog Id |
String |
The ID of the worklog. |
x |
|
Property Key |
String |
The key of the property. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Issue Security Schemes
<jira:get-rest-api3-issuesecurityschemes>
Returns all issue security schemes.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/issuesecurityschemes endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Issue Security Scheme
<jira:get-rest-api3-issuesecurityschemes-by-id>
Returns an issue security scheme along with its security levels.
Permissions required:
-
Administer Jira global permission.
-
Administer Projects project permission for a project that uses the requested issue security scheme.
This operation makes an HTTP GET request to the /rest/api/3/issuesecurityschemes/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the issue security scheme. Use the [Get issue security schemes](#api-rest-api-3-issuesecurityschemes-get) operation to get a list of issue security scheme IDs. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Issue Security Level Members
<jira:get-rest-api3-issuesecurityschemes-members-by-issue-security-scheme-id>
Returns issue security level members. Only issue security level members in context of classic projects are returned.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/issuesecurityschemes/{issueSecuritySchemeId}/members endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Security Scheme Id |
Number |
The ID of the issue security scheme. Use the [Get issue security schemes](#api-rest-api-3-issuesecurityschemes-get) operation to get a list of issue security scheme IDs. |
x |
|
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
50 |
|
Issue Security Level Id |
Array of Number |
The list of issue security level IDs. To include multiple issue security levels separate IDs with ampersand: |
||
expand |
String |
Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include: * |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Issue All Types
<jira:get-rest-api3-issuetype>
Returns all issue types. This operation can be accessed anonymously.
Permissions required:
Issue types are only returned as follows:
-
if the user has the Administer Jira global permission, all issue types are returned.
-
if the user has the Browse projects project permission for one or more projects, the issue types associated with the projects the user has permission to browse are returned.
This operation makes an HTTP GET request to the /rest/api/3/issuetype endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Alternative Issue Types
<jira:get-rest-api3-issuetype-alternatives-by-id>
Returns a list of issue types that can be used to replace the issue type. The alternative issue types are those assigned to the same workflow scheme, field configuration scheme, and screen scheme. This operation can be accessed anonymously.
Permissions required:
None.
This operation makes an HTTP GET request to the /rest/api/3/issuetype/{id}/alternatives endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
The ID of the issue type. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Issue Type
<jira:get-rest-api3-issuetype-by-id>
Returns an issue type. This operation can be accessed anonymously.
Permissions required:
Browse projects project permission in a project the issue type is associated with or Administer Jira global permission.
This operation makes an HTTP GET request to the /rest/api/3/issuetype/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
The ID of the issue type. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Issue Type Property Keys
<jira:get-rest-api3-issuetype-properties-by-issue-type-id>
Returns all the issue type property keys of the issue type. This operation can be accessed anonymously.
Permissions required:
-
Administer Jira global permission to get the property keys of any issue type.
-
Browse projects project permission to get the property keys of any issue types associated with the projects the user has permission to browse.
This operation makes an HTTP GET request to the /rest/api/3/issuetype/{issueTypeId}/properties endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Type Id |
String |
The ID of the issue type. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Issue Type Property
<jira:get-rest-api3-issuetype-properties-by-issue-type-id-property-key>
Returns the key and value of the issue type property. This operation can be accessed anonymously.
Permissions required:
-
Administer Jira global permission to get the details of any issue type.
-
Browse projects project permission to get the details of any issue types associated with the projects the user has permission to browse.
This operation makes an HTTP GET request to the /rest/api/3/issuetype/{issueTypeId}/properties/{propertyKey} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Type Id |
String |
The ID of the issue type. |
x |
|
Property Key |
String |
The key of the property. Use [Get issue type property keys](#api-rest-api-3-issuetype-issueTypeId-properties-get) to get a list of all issue type property keys. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get All Issue Type Schemes
<jira:get-rest-api3-issuetypescheme>
Returns a paginated list of issue type schemes. Only issue type schemes used in classic projects are returned.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/issuetypescheme endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
50 |
|
id |
Array of Number |
The list of issue type schemes IDs. To include multiple IDs, provide an ampersand-separated list. For example, |
||
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Issue Type Schemes Mapping
<jira:get-rest-api3-issuetypescheme-mapping>
Returns a paginated list of issue type scheme items. Only issue type scheme items used in classic projects are returned.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/issuetypescheme/mapping endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
50 |
|
Issue Type Scheme Id |
Array of Number |
The list of issue type scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Issue Type Scheme For Projects
<jira:get-rest-api3-issuetypescheme-project>
Returns a paginated list of issue type schemes and, for each issue type scheme, a list of the projects that use it. Only issue type schemes used in classic projects are returned.
Permissions required:
Administer Jira global permission.
This operation makes an HTTP GET request to the /rest/api/3/issuetypescheme/project endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
50 |
|
Project Id |
Array of Number |
The list of project IDs. To include multiple project IDs, provide an ampersand-separated list. For example, |
x |
|
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Issue Type Screen Schemes
<jira:get-rest-api3-issuetypescreenscheme>
Returns a paginated list of issue type screen schemes. Only issue type screen schemes used in classic projects are returned.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/issuetypescreenscheme endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
50 |
|
id |
Array of Number |
The list of issue type screen scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Issue Type Screen Scheme Mappings
<jira:get-rest-api3-issuetypescreenscheme-mapping>
Returns a paginated list of issue type screen scheme items. Only issue type screen schemes used in classic projects are returned.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/issuetypescreenscheme/mapping endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
50 |
|
Issue Type Screen Scheme Id |
Array of Number |
The list of issue type screen scheme IDs. To include multiple issue type screen schemes, separate IDs with ampersand: |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Issue Type Screen Scheme Project Associations
<jira:get-rest-api3-issuetypescreenscheme-project>
Returns a paginated list of issue type screen schemes and, for each issue type screen scheme, a list of the projects that use it. Only issue type screen schemes used in classic projects are returned.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/issuetypescreenscheme/project endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
50 |
|
Project Id |
Array of Number |
The list of project IDs. To include multiple projects, separate IDs with ampersand: |
x |
|
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Auto Complete
<jira:get-rest-api3-jql-autocompletedata>
Returns reference data for JQL searches. This is a downloadable version of the documentation provided in [Advanced searching - fields reference](https://confluence.atlassian.com/x/gwORLQ) and Advanced searching - functions reference, along with a list of JQL-reserved words. Use this information to assist with the programmatic creation of JQL queries or the validation of queries built in a custom query builder. This operation can be accessed anonymously.
Permissions required:
None.
This operation makes an HTTP GET request to the /rest/api/3/jql/autocompletedata endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Field Auto Complete For Query String
<jira:get-rest-api3-jql-autocompletedata-suggestions>
Returns the JQL search auto complete suggestions for a field. Suggestions can be obtained by providing:
-
fieldNameto get a list of all values for the field. -
fieldNameandfieldValueto get a list of values containing the text infieldValue. -
fieldNameandpredicateNameto get a list of all predicate values for the field. -
fieldName,predicateName, andpredicateValueto get a list of predicate values containing the text inpredicateValue.
This operation can be accessed anonymously.
Permissions required:
None.
This operation makes an HTTP GET request to the /rest/api/3/jql/autocompletedata/suggestions endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Field Name |
String |
The name of the field. |
||
Field Value |
String |
The partial field item name entered by the user. |
||
Predicate Name |
String |
The name of the CHANGED operator predicate for which the suggestions are generated. The valid predicate operators are by, from, and to. |
||
Predicate Value |
String |
The partial predicate item name entered by the user. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get All Labels
<jira:get-rest-api3-label>
Returns a paginated list of labels. This operation makes an HTTP GET request to the /rest/api/3/label endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
1000 |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get My Permissions
<jira:get-rest-api3-mypermissions>
Returns a list of permissions indicating which permissions the user has. Details of the user’s permissions can be obtained in a global, project, or issue context. The user is reported as having a project permission:
-
in the global context, if the user has the project permission in any project.
-
for a project, where the project permission is determined using issue data, if the user meets the permission’s criteria for any issue in the project. Otherwise, if the user has the project permission in the project.
-
for an issue, where a project permission is determined using issue data, if the user has the permission in the issue. Otherwise, if the user has the project permission in the project containing the issue. This means that users may be shown as having an issue permission (such as EDIT\_ISSUES) in the global context or a project context but may not have the permission for any or all issues. For example, if Reporters have the EDIT\_ISSUES permission a user would be shown as having this permission in the global context or the context of a project, because any user can be a reporter. However, if they are not the user who reported the issue queried they would not have EDIT\_ISSUES permission for that issue. Global permissions are unaffected by context.
This operation can be accessed anonymously.
Permissions required:
None.
This operation makes an HTTP GET request to the /rest/api/3/mypermissions endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Project Key |
String |
The key of project. Ignored if |
||
Project Id |
String |
The ID of project. |
||
Issue Key |
String |
The key of the issue. Ignored if |
||
Issue Id |
String |
The ID of the issue. |
||
permissions |
String |
A list of permission keys. (Required) This parameter accepts a comma-separated list. To get the list of available permissions, use [Get all permissions](#api-rest-api-3-permissions-get). |
||
Project Uuid |
String |
Project Uuid |
||
Project Configuration Uuid |
String |
Project Configuration Uuid |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Preference
<jira:get-rest-api3-mypreferences>
Returns the value of a preference of the current user. Note that these keys are deprecated:
-
jira.user.locale The locale of the user. By default this is not set and the user takes the locale of the instance.
-
jira.user.timezone The time zone of the user. By default this is not set and the user takes the timezone of the instance. Use Update a user profile from the user management REST API to manage timezone and locale instead.
Permissions required:
Permission to access Jira.
This operation makes an HTTP GET request to the /rest/api/3/mypreferences endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
key |
String |
The key of the preference. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Locale
<jira:get-rest-api3-mypreferences-locale>
Returns the locale for the user. If the user has no language preference set (which is the default setting) or this resource is accessed anonymous, the browser locale detected by Jira is returned. Jira detects the browser locale using the Accept-Language header in the request. However, if this doesn’t match a locale available Jira, the site default locale is returned. This operation can be accessed anonymously.
Permissions required:
None.
This operation makes an HTTP GET request to the /rest/api/3/mypreferences/locale endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Current User
<jira:get-rest-api3-myself>
Returns details for the current user.
Permissions required:
Permission to access Jira.
This operation makes an HTTP GET request to the /rest/api/3/myself endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
expand |
String |
Use
|
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Notification Schemes
<jira:get-rest-api3-notificationscheme>
Returns a paginated list of notification schemes ordered by display name.
About notification schemes
A notification scheme is a list of events and recipients who will receive notifications for those events. The list is contained within the notificationSchemeEvents object and contains pairs of events and notifications:
-
eventIdentifies the type of event. The events can be Jira system events or custom events. -
notificationsIdentifies the recipients of notifications for each event.Recipients can be any of the following types:
-
CurrentAssignee -
Reporter -
CurrentUser -
ProjectLead -
ComponentLead -
User(theparameteris the user key) -
Group(theparameteris the group name) -
ProjectRole(theparameteris the project role ID) -
EmailAddress -
AllWatchers
-
-
UserCustomField(theparameteris the ID of the custom field) -
GroupCustomField(theparameteris the ID of the custom field) Note that you should allow for events without recipients to appear in responses.
Permissions required:
Permission to access Jira, however the user must have permission to administer at least one project associated with a notification scheme for it to be returned. This operation makes an HTTP GET request to the /rest/api/3/notificationscheme endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
50 |
|
expand |
String |
Use
|
||
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Notification Scheme
<jira:get-rest-api3-notificationscheme-by-id>
Returns a notification scheme, including the list of events and the recipients who will receive notifications for those events.
Permissions required:
Permission to access Jira, however the user must have permission to administer at least one project associated with the notification scheme.
This operation makes an HTTP GET request to the /rest/api/3/notificationscheme/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the notification scheme. Use [Get notification schemes paginated](#api-rest-api-3-notificationscheme-get) to get a list of notification scheme IDs. |
x |
|
expand |
String |
Use
|
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get All Permissions
<jira:get-rest-api3-permissions>
Returns all permissions, including: * global permissions. * project permissions. * global permissions added by plugins.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/permissions endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get All Permission Schemes
<jira:get-rest-api3-permissionscheme>
Returns all permission schemes.
About permission schemes and grants
A permission scheme is a collection of permission grants. A permission grant consists of a holder and a permission.
Holder object
The holder object contains information about the user or group being granted the permission. For example, the Administer projects permission is granted to a group named Teams in space administrators. In this case, the type is "type": "group", and the parameter is the group name, "parameter": "Teams in space administrators".
The holder object is defined by the following properties:
-
typeIdentifies the user or group (see the list of types below). -
parameterThe value of this property depends on thetype. For example, if thetypeis a group, then you need to specify the group name. The followingtypesare available. The expected values for theparameterare given in parenthesis (sometypesmay not have aparameter):-
anyoneGrant for anonymous users. -
applicationRoleGrant for users with access to the specified application (application name). See [Update product access settings](https://confluence.atlassian.com/x/3YxjL) for more information. -
assigneeGrant for the user currently assigned to an issue. -
groupGrant for the specified group (group name). -
groupCustomFieldGrant for a user in the group selected in the specified custom field (custom field ID). -
projectLeadGrant for a project lead. -
projectRoleGrant for the specified project role (project role ID). -
reporterGrant for the user who reported the issue. *sd.customer.portal.onlyJira Service Desk only. Grants customers permission to access the customer portal but not Jira. See [Customizing Jira Service Desk permissions](https://confluence.atlassian.com/x/24dKLg) for more information. -
userGrant for the specified user (user ID - historically this was the userkey but that is deprecated and the account ID should be used). -
userCustomFieldGrant for a user selected in the specified custom field (custom field ID).
-
Built-in permissions
The [built-in Jira permissions](https://confluence.atlassian.com/x/yodKLg) are listed below. Apps can also define custom permissions. See the project permission and global permission module documentation for more information.
Project permissions
-
ADMINISTER_PROJECTS -
BROWSE_PROJECTS -
MANAGE_SPRINTS_PERMISSION(Jira Software only) -
SERVICEDESK_AGENT(Jira Service Desk only) -
VIEW_DEV_TOOLS(Jira Software only) -
VIEW_READONLY_WORKFLOW
Issue permissions
-
ASSIGNABLE_USER -
ASSIGN_ISSUES -
CLOSE_ISSUES -
CREATE_ISSUES -
DELETE_ISSUES -
EDIT_ISSUES -
LINK_ISSUES -
MODIFY_REPORTER -
MOVE_ISSUES -
RESOLVE_ISSUES -
SCHEDULE_ISSUES -
SET_ISSUE_SECURITY -
TRANSITION_ISSUES
Voters and watchers permissions
-
MANAGE_WATCHERS -
VIEW_VOTERS_AND_WATCHERS
Comments permissions
-
ADD_COMMENTS -
DELETE_ALL_COMMENTS -
DELETE_OWN_COMMENTS -
EDIT_ALL_COMMENTS -
EDIT_OWN_COMMENTS
Attachments permissions
-
CREATE_ATTACHMENTS -
DELETE_ALL_ATTACHMENTS -
DELETE_OWN_ATTACHMENTS
Time tracking permissions
-
DELETE_ALL_WORKLOGS -
DELETE_OWN_WORKLOGS -
EDIT_ALL_WORKLOGS -
EDIT_OWN_WORKLOGS -
WORK_ON_ISSUES
Permissions required:
Permission to access Jira.
This operation makes an HTTP GET request to the /rest/api/3/permissionscheme endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
expand |
String |
Use
|
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Permission Scheme
<jira:get-rest-api3-permissionscheme-by-scheme-id>
Returns a permission scheme.
Permissions required:
Permission to access Jira.
This operation makes an HTTP GET request to the /rest/api/3/permissionscheme/{schemeId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Scheme Id |
Number |
The ID of the permission scheme to return. |
x |
|
expand |
String |
Use
|
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Permission Scheme Grants
<jira:get-rest-api3-permissionscheme-permission-by-scheme-id>
Returns all permission grants for a permission scheme.
Permissions required:
Permission to access Jira.
This operation makes an HTTP GET request to the /rest/api/3/permissionscheme/{schemeId}/permission endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Scheme Id |
Number |
The ID of the permission scheme. |
x |
|
expand |
String |
Use
|
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Permission Scheme Grant
<jira:get-rest-api3-permissionscheme-permission-by-scheme-id-permission-id>
Returns a permission grant.
Permissions required:
Permission to access Jira.
This operation makes an HTTP GET request to the /rest/api/3/permissionscheme/{schemeId}/permission/{permissionId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Scheme Id |
Number |
The ID of the permission scheme. |
x |
|
Permission Id |
Number |
The ID of the permission grant. |
x |
|
expand |
String |
Use expand to include additional information in the response. This parameter accepts a comma-separated list. Note that permissions are always included when you specify any value. Expand options include:
|
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Priorities
<jira:get-rest-api3-priority>
Returns the list of all issue priorities.
Permissions required:
Permission to access Jira.
This operation makes an HTTP GET request to the /rest/api/3/priority endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Priority
<jira:get-rest-api3-priority-by-id>
Returns an issue priority.
Permissions required:
Permission to access Jira.
This operation makes an HTTP GET request to the /rest/api/3/priority/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
The ID of the issue priority. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get All Project Avatars
<jira:get-rest-api3-project-avatars-by-project-id-or-key>
Returns all project avatars, grouped by system and custom avatars. This operation can be accessed anonymously.
Permissions required:
Browse projects project permission for the project.
This operation makes an HTTP GET request to the /rest/api/3/project/{projectIdOrKey}/avatars endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Project Id Or Key |
String |
The ID or (case-sensitive) key of the project. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Project
<jira:get-rest-api3-project-by-project-id-or-key>
Returns the [project details](https://confluence.atlassian.com/x/ahLpNw) for a project. This operation can be accessed anonymously.
Permissions required:
Browse projects project permission for the project.
This operation makes an HTTP GET request to the /rest/api/3/project/{projectIdOrKey} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Project Id Or Key |
String |
The project ID or project key (case sensitive). |
x |
|
expand |
String |
Use
|
||
properties |
Array of String |
A list of project properties to return for the project. This parameter accepts a comma-separated list. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get All Project Categories
<jira:get-rest-api3-project-category>
Returns all project categories.
Permissions required:
Permission to access Jira.
This operation makes an HTTP GET request to the /rest/api/3/projectCategory endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Project Category By Id
<jira:get-rest-api3-project-category-by-id>
Returns a project category.
Permissions required:
Permission to access Jira.
This operation makes an HTTP GET request to the /rest/api/3/projectCategory/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the project category. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Project Components Paginated
<jira:get-rest-api3-project-component-by-project-id-or-key>
Returns a paginated list of all components in a project. See the [Get project components](#api-rest-api-3-project-projectIdOrKey-components-get) resource if you want to get a full list of versions without pagination. This operation can be accessed anonymously.
Permissions required:
Browse Projects project permission for the project.
This operation makes an HTTP GET request to the /rest/api/3/project/{projectIdOrKey}/component endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Project Id Or Key |
String |
The project ID or project key (case sensitive). |
x |
|
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
50 |
|
Order By |
Enumeration, one of:
|
Order the results by a field:
|
||
query |
String |
Filter the results using a literal string. Components with a matching |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Project Components
<jira:get-rest-api3-project-components-by-project-id-or-key>
Returns all components in a project. See the [Get project components paginated](#api-rest-api-3-project-projectIdOrKey-component-get) resource if you want to get a full list of components with pagination. This operation can be accessed anonymously.
Permissions required:
Browse Projects project permission for the project.
This operation makes an HTTP GET request to the /rest/api/3/project/{projectIdOrKey}/components endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Project Id Or Key |
String |
The project ID or project key (case sensitive). |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Project Email
<jira:get-rest-api3-project-email-by-project-id>
Returns the [project’s sender email address](https://confluence.atlassian.com/x/dolKLg).
Permissions required:
Browse projects project permission for the project.
This operation makes an HTTP GET request to the /rest/api/3/project/{projectId}/email endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Project Id |
Number |
The project ID. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Hierarchy
<jira:get-rest-api3-project-hierarchy-by-project-id>
Get the issue type hierarchy for a next-gen project. The issue type hierarchy for a project consists of:
-
Epic at level 1 (optional).
-
One or more issue types at level 0 such as Story, Task, or Bug. Where the issue type Epic is defined, these issue types are used to break down the content of an epic.
-
Subtask at level -1 (optional). This issue type enables level 0 issue types to be broken down into components. Issues based on a level -1 issue type must have a parent issue.
Permissions required:
Browse projects project permission for the project.
This operation makes an HTTP GET request to the /rest/api/3/project/{projectId}/hierarchy endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Project Id |
Number |
The ID of the project. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Project Issue Security Scheme
<jira:get-rest-api3-project-issuesecuritylevelscheme-by-project-key-or-id>
Returns the issue security scheme associated with the project.
Permissions required:
Administer Jira global permission or the Administer Projects project permission.
This operation makes an HTTP GET request to the /rest/api/3/project/{projectKeyOrId}/issuesecuritylevelscheme endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Project Key Or Id |
String |
The project ID or project key (case sensitive). |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Notification Scheme For Project
<jira:get-rest-api3-project-notificationscheme-by-project-key-or-id>
Gets a notification scheme associated with the project. See the [Get notification scheme](#api-rest-api-3-notificationscheme-id-get) resource for more information about notification schemes.
Permissions required:
Administer Jira global permission or Administer Projects project permission.
This operation makes an HTTP GET request to the /rest/api/3/project/{projectKeyOrId}/notificationscheme endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Project Key Or Id |
String |
The project ID or project key (case sensitive). |
x |
|
expand |
String |
Use
|
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Assigned Permission Scheme
<jira:get-rest-api3-project-permissionscheme-by-project-key-or-id>
Gets the permission scheme associated with the project.
Permissions required:
Administer Jira global permission or Administer projects project permission.
This operation makes an HTTP GET request to the /rest/api/3/project/{projectKeyOrId}/permissionscheme endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Project Key Or Id |
String |
The project ID or project key (case sensitive). |
x |
|
expand |
String |
Use
|
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Project Property Keys
<jira:get-rest-api3-project-properties-by-project-id-or-key>
Returns all project property keys for the project. This operation can be accessed anonymously.
Permissions required:
Browse Projects project permission for the project.
This operation makes an HTTP GET request to the /rest/api/3/project/{projectIdOrKey}/properties endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Project Id Or Key |
String |
The project ID or project key (case sensitive). |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Project Property
<jira:get-rest-api3-project-properties-by-project-id-or-key-property-key>
Returns the value of a [project property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties). This operation can be accessed anonymously.
Permissions required:
Browse Projects project permission for the project containing the property.
This operation makes an HTTP GET request to the /rest/api/3/project/{projectIdOrKey}/properties/{propertyKey} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Project Id Or Key |
String |
The project ID or project key (case sensitive). |
x |
|
Property Key |
String |
The project property key. Use [Get project property keys](#api-rest-api-3-project-projectIdOrKey-properties-get) to get a list of all project property keys. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Project Roles
<jira:get-rest-api3-project-role-by-project-id-or-key>
Returns a list of project roles for the project returning the name and self URL for each role. Note that all project roles are shared with all projects in Jira Cloud. See [Get all project roles](#api-rest-api-3-role-get) for more information. This operation can be accessed anonymously.
Permissions required:
Administer Projects project permission for any project on the site or Administer Jira global permission.
This operation makes an HTTP GET request to the /rest/api/3/project/{projectIdOrKey}/role endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Project Id Or Key |
String |
The project ID or project key (case sensitive). |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Project Role
<jira:get-rest-api3-project-role-by-project-id-or-key-id>
Returns a project role’s details and actors associated with the project. The list of actors is sorted by display name. To check whether a user belongs to a role based on their group memberships, use [Get user](#api-rest-api-3-user-get) with the groups expand parameter selected. Then check whether the user keys and groups match with the actors returned for the project. This operation can be accessed anonymously.
Permissions required:
Administer Projects project permission for the project or Administer Jira global permission.
This operation makes an HTTP GET request to the /rest/api/3/project/{projectIdOrKey}/role/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Project Id Or Key |
String |
The project ID or project key (case sensitive). |
x |
|
id |
Number |
The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Project Role Details
<jira:get-rest-api3-project-roledetails-by-project-id-or-key>
Returns all project roles and the details for each role. Note that the list of project roles is common to all projects. This operation can be accessed anonymously.
Permissions required:
Administer Jira global permission or Administer projects project permission for the project.
This operation makes an HTTP GET request to the /rest/api/3/project/{projectIdOrKey}/roledetails endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Project Id Or Key |
String |
The project ID or project key (case sensitive). |
x |
|
Current Member |
Boolean |
Whether the roles should be filtered to include only those the user is assigned to. |
false |
|
Exclude Connect Addons |
Boolean |
Exclude Connect Addons |
false |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Search Projects
<jira:get-rest-api3-project-search>
Returns a paginated list of projects visible to the user. This operation can be accessed anonymously.
Permissions required:
Projects are returned only where the user has one of:
-
Browse Projects project permission for the project.
-
Administer Projects project permission for the project.
-
Administer Jira global permission.
This operation makes an HTTP GET request to the /rest/api/3/project/search endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
50 |
|
Order By |
Enumeration, one of:
|
Order the results by a field.
|
KEY |
|
query |
String |
Filter the results using a literal string. Projects with a matching |
||
Type Key |
String |
Orders results by the [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes). This parameter accepts a comma-separated list. Valid values are |
||
Category Id |
Number |
The ID of the project’s category. A complete list of category IDs is found using the [Get all project categories](#api-rest-api-3-projectCategory-get) operation. |
||
action |
Enumeration, one of:
|
Filter results by projects for which the user can:
|
VIEW |
|
expand |
String |
Use
|
||
status |
Array of Enumeration, one of:
|
EXPERIMENTAL. Filter results by project status:
|
||
properties |
Array of String |
EXPERIMENTAL. A list of project properties to return for the project. This parameter accepts a comma-separated list. |
||
Property Query |
String |
EXPERIMENTAL. A query string used to search properties. The query string cannot be specified using a JSON object. For example, to search for the value of |
||
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Security Levels For Project
<jira:get-rest-api3-project-securitylevel-by-project-key-or-id>
Returns all issue security levels for the project that the user has access to. This operation can be accessed anonymously.
Permissions required:
Browse projects global permission for the project, however, issue security levels are only returned for authenticated user with Set Issue Security global permission for the project.
This operation makes an HTTP GET request to the /rest/api/3/project/{projectKeyOrId}/securitylevel endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Project Key Or Id |
String |
The project ID or project key (case sensitive). |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get All Statuses
<jira:get-rest-api3-project-statuses-by-project-id-or-key>
Returns the valid statuses for a project. The statuses are grouped by issue type, as each project has a set of valid issue types and each issue type has a set of valid statuses. This operation can be accessed anonymously.
Permissions required:
Browse Projects project permission for the project.
This operation makes an HTTP GET request to the /rest/api/3/project/{projectIdOrKey}/statuses endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Project Id Or Key |
String |
The project ID or project key (case sensitive). |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get All Project Types
<jira:get-rest-api3-project-type>
Returns all project types, whether or not the instance has a valid license for each type. This operation can be accessed anonymously.
Permissions required:
None.
This operation makes an HTTP GET request to the /rest/api/3/project/type endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get All Accessible Project Types
<jira:get-rest-api3-project-type-accessible>
Returns all project types with a valid license.
This operation makes an HTTP GET request to the /rest/api/3/project/type/accessible endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Accessible Project Type By Key
<jira:get-rest-api3-project-type-accessible-by-project-type-key>
Returns a project type if it is accessible to the user.
Permissions required:
Permission to access Jira.
This operation makes an HTTP GET request to the /rest/api/3/project/type/{projectTypeKey}/accessible endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Project Type Key |
Enumeration, one of:
|
The key of the project type. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Project Type By Key
<jira:get-rest-api3-project-type-by-project-type-key>
Returns a [project type](https://confluence.atlassian.com/x/Var1Nw). This operation can be accessed anonymously.
Permissions required:
None.
This operation makes an HTTP GET request to the /rest/api/3/project/type/{projectTypeKey} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Project Type Key |
Enumeration, one of:
|
The key of the project type. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Project Versions Paginated
<jira:get-rest-api3-project-version-by-project-id-or-key>
Returns a paginated list of all versions in a project. See the [Get project versions](#api-rest-api-3-project-projectIdOrKey-versions-get) resource if you want to get a full list of versions without pagination. This operation can be accessed anonymously.
Permissions required:
Browse Projects project permission for the project.
This operation makes an HTTP GET request to the /rest/api/3/project/{projectIdOrKey}/version endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Project Id Or Key |
String |
The project ID or project key (case sensitive). |
x |
|
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
50 |
|
Order By |
Enumeration, one of:
|
Order the results by a field:
|
||
query |
String |
Filter the results using a literal string. Versions with matching |
||
status |
String |
A list of status values used to filter the results by version status. This parameter accepts a comma-separated list. The status values are |
||
expand |
String |
Use
|
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Project Versions
<jira:get-rest-api3-project-versions-by-project-id-or-key>
Returns all versions in a project. The response is not paginated. Use [Get project versions paginated](#api-rest-api-3-project-projectIdOrKey-version-get) if you want to get the versions in a project with pagination. This operation can be accessed anonymously.
Permissions required:
Browse Projects project permission for the project.
This operation makes an HTTP GET request to the /rest/api/3/project/{projectIdOrKey}/versions endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Project Id Or Key |
String |
The project ID or project key (case sensitive). |
x |
|
expand |
String |
Use |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Validate Project Key
<jira:get-rest-api3-projectvalidate-key>
Validates a project key by confirming the key is a valid string and not in use.
Permissions required:
None.
This operation makes an HTTP GET request to the /rest/api/3/projectvalidate/key endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
key |
String |
The project key. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Valid Project Key
<jira:get-rest-api3-projectvalidate-valid-project-key>
Validates a project key and, if the key is invalid or in use, generates a valid random string for the project key.
Permissions required:
None.
This operation makes an HTTP GET request to the /rest/api/3/projectvalidate/validProjectKey endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
key |
String |
The project key. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Valid Project Name
<jira:get-rest-api3-projectvalidate-valid-project-name>
Checks that a project name isn’t in use. If the name isn’t in use, the passed string is returned. If the name is in use, this operation attempts to generate a valid project name based on the one supplied, usually by adding a sequence number. If a valid project name cannot be generated, a 404 response is returned.
Permissions required:
None.
This operation makes an HTTP GET request to the /rest/api/3/projectvalidate/validProjectName endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
name |
String |
The project name. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Resolutions
<jira:get-rest-api3-resolution>
Returns a list of all issue resolution values.
Permissions required:
Permission to access Jira.
This operation makes an HTTP GET request to the /rest/api/3/resolution endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Resolution
<jira:get-rest-api3-resolution-by-id>
Returns an issue resolution value.
Permissions required:
Permission to access Jira.
This operation makes an HTTP GET request to the /rest/api/3/resolution/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
The ID of the issue resolution value. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get All Project Roles
<jira:get-rest-api3-role>
Gets a list of all project roles, complete with project role details and default actors.
About project roles
Project roles are a flexible way to associate users and groups with projects. In Jira Cloud, the list of project roles is shared globally with all projects, but each project can have a different set of actors associated with it (unlike groups, which have the same membership throughout all Jira applications). Project roles are used in [permission schemes](#api-rest-api-3-permissionscheme-get), [email notification schemes](#api-rest-api-3-notificationscheme-get), [issue security levels](#api-rest-api-3-issuesecurityschemes-get), [comment visibility](#api-rest-api-3-comment-list-post), and workflow conditions.
Members and actors
In the Jira REST API, a member of a project role is called an actor. An actor is a group or user associated with a project role. Actors may be set as default members of the project role or set at the project level:
-
Default actors: Users and groups that are assigned to the project role for all newly created projects. The default actors can be removed at the project level later if desired.
-
Actors: Users and groups that are associated with a project role for a project, which may differ from the default actors. This enables you to assign a user to different roles in different projects.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/role endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Project Role Actors For Role
<jira:get-rest-api3-role-actors-by-id>
Returns the [default actors](#api-rest-api-3-resolution-get) for the project role.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/role/{id}/actors endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Project Role By Id
<jira:get-rest-api3-role-by-id>
Gets the project role details and the default actors associated with the role. The list of default actors is sorted by display name.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/role/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Screens
<jira:get-rest-api3-screens>
Returns a paginated list of all screens or those specified by one or more screen IDs.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/screens endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
100 |
|
id |
Array of Number |
The list of screen IDs. To include multiple IDs, provide an ampersand-separated list. For example, |
||
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Available Screen Fields
<jira:get-rest-api3-screens-available-fields-by-screen-id>
Returns the fields that can be added to a tab on a screen.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/screens/{screenId}/availableFields endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Screen Id |
Number |
The ID of the screen. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get All Screen Tabs
<jira:get-rest-api3-screens-tabs-by-screen-id>
Returns the list of tabs for a screen.
Permissions required:
-
Administer Jira global permission.
-
Administer projects project permission when the project key is specified, providing that the screen is associated with the project through a Screen Scheme and Issue Type Screen Scheme.
This operation makes an HTTP GET request to the /rest/api/3/screens/{screenId}/tabs endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Screen Id |
Number |
The ID of the screen. |
x |
|
Project Key |
String |
The key of the project. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get All Screen Tab Fields
<jira:get-rest-api3-screens-tabs-fields-by-screen-id-tab-id>
Returns all fields for a screen tab.
Permissions required:
-
Administer Jira global permission.
-
Administer projects project permission when the project key is specified, providing that the screen is associated with the project through a Screen Scheme and Issue Type Screen Scheme.
This operation makes an HTTP GET request to the /rest/api/3/screens/{screenId}/tabs/{tabId}/fields endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Screen Id |
Number |
The ID of the screen. |
x |
|
Tab Id |
Number |
The ID of the screen tab. |
x |
|
Project Key |
String |
The key of the project. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Screen Schemes
<jira:get-rest-api3-screenscheme>
Returns a paginated list of screen schemes. Only screen schemes used in classic projects are returned.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/screenscheme endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
25 |
|
id |
Array of Number |
The list of screen scheme IDs. To include multiple IDs, provide an ampersand-separated list. For example, |
||
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Search For Issues Using JQL
<jira:get-rest-api3-search>
Searches for issues using JQL. If the JQL query expression is too large to be encoded as a query parameter, use the [POST](#api-rest-api-3-search-post) version of this resource. This operation can be accessed anonymously.
Permissions required:
Issues are included in the response where the user has:
-
Browse projects project permission for the project containing the issue.
-
If issue-level security is configured, issue-level security permission to view the issue.
This operation makes an HTTP GET request to the /rest/api/3/search endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
jql |
String |
The JQL that defines the search. Note:
|
||
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. To manage page size, Jira may return fewer items per page where a large number of fields are requested. The greatest number of items returned per page is achieved when requesting |
50 |
|
Validate Query |
Enumeration, one of:
|
Determines how to validate the JQL query and treat the validation results. Supported values are:
|
STRICT |
|
fields |
Array of String |
A list of fields to return for each issue, use it to retrieve a subset of fields. This parameter accepts a comma-separated list. Expand options include:
Examples:
This parameter can be specified multiple times. For example, |
||
expand |
String |
Use
|
||
properties |
Array of String |
A list of issue property keys for issue properties to include in the results. This parameter accepts a comma-separated list. Multiple properties can also be provided using an ampersand separated list. For example, |
||
Fields By Keys |
Boolean |
Reference fields by their key (rather than ID). |
false |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Issue Security Level
<jira:get-rest-api3-securitylevel-by-id>
Returns details of an issue security level. Use [Get issue security scheme](#api-rest-api-3-issuesecurityschemes-id-get) to obtain the IDs of issue security levels associated with the issue security scheme. This operation can be accessed anonymously.
Permissions required:
None.
This operation makes an HTTP GET request to the /rest/api/3/securitylevel/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
The ID of the issue security level. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Server Info
<jira:get-rest-api3-server-info>
Returns information about the Jira instance. This operation can be accessed anonymously.
Permissions required:
None.
This operation makes an HTTP GET request to the /rest/api/3/serverInfo endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Issue Navigator Default Columns
<jira:get-rest-api3-settings-columns>
Returns the default issue navigator columns.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/settings/columns endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Statuses
<jira:get-rest-api3-status>
Returns a list of all statuses associated with workflows. This operation can be accessed anonymously.
Permissions required:
None.
This operation makes an HTTP GET request to the /rest/api/3/status endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Status
<jira:get-rest-api3-status-by-id-or-name>
Returns a status. The status must be associated with a workflow to be returned. If a name is used on more than one status, only the status found first is returned. Therefore, identifying the status by its ID may be preferable. This operation can be accessed anonymously.
Permissions required:
None.
This operation makes an HTTP GET request to the /rest/api/3/status/{idOrName} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Id Or Name |
String |
The ID or name of the status. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Status Categories
<jira:get-rest-api3-statuscategory>
Returns a list of all status categories.
Permissions required:
Permission to access Jira.
This operation makes an HTTP GET request to the /rest/api/3/statuscategory endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Status Category
<jira:get-rest-api3-statuscategory-by-id-or-key>
Returns a status category. Status categories provided a mechanism for categorizing [statuses](#api-rest-api-3-status-idOrName-get).
Permissions required:
Permission to access Jira.
This operation makes an HTTP GET request to the /rest/api/3/statuscategory/{idOrKey} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Id Or Key |
String |
The ID or key of the status category. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Task
<jira:get-rest-api3-task-by-task-id>
Returns the status of a [long-running asynchronous task](#async). When a task has finished, this operation returns the JSON blob applicable to the task. See the documentation of the operation that created the task for details. Task details are not permanently retained. As of September 2019, details are retained for 14 days, although this period may change without notice.
Permissions required:
Either of:
-
Administer Jira global permission
-
Creator of the task
This operation makes an HTTP GET request to the /rest/api/3/task/{taskId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Task Id |
String |
The ID of the task. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Avatars
<jira:get-rest-api3-universal-avatar-type-owner-by-type-entity-id>
Returns the system and custom avatars for a project or issue type. This operation can be accessed anonymously.
Permissions required:
None.
This operation makes an HTTP GET request to the /rest/api/3/universal_avatar/type/{type}/owner/{entityId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
type |
Enumeration, one of:
|
The avatar type. |
x |
|
Entity Id |
String |
The ID of the item the avatar is associated with. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get User
<jira:get-rest-api3-user>
Returns a user.
Permissions required:
Browse users and groups global permission
This operation makes an HTTP GET request to the /rest/api/3/user endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required. |
||
username |
String |
This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details. |
||
key |
String |
This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details. |
||
expand |
String |
Use
|
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Find Bulk Assignable Users
<jira:get-rest-api3-user-assignable-multi-project-search>
Returns a list of users who can be assigned issues in one or more projects. The list may be restricted to users whose attributes match a string. This operation takes the users in the range defined by startAt and maxResults, up to the thousandth user, and then returns only the users from that range that can be assigned issues in the projects. This means the operation usually returns fewer users than specified in maxResults.
To get all the users who can be assigned issues in the projects, use [Get all users](#api-rest-api-3-users-search-get) and filter the records in your code.
This operation can be accessed anonymously.
Permissions required:
None.
This operation makes an HTTP GET request to the /rest/api/3/user/assignable/multiProjectSearch endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
query |
String |
A query string that is matched against user attributes, such as |
||
username |
String |
This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details. |
||
Account Id |
String |
A query string that is matched exactly against user |
||
Project Keys |
String |
A list of project keys (case sensitive). This parameter accepts a comma-separated list. |
x |
|
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
50 |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Find Assignable Users
<jira:get-rest-api3-user-assignable-search>
Returns a list of users that can be assigned to an issue. Use this operation to find the list of users who can be assigned to:
-
a new issue, by providing the
projectKeyOrId. -
an updated issue, by providing the
issueKey. -
to an issue during a transition (workflow action), by providing the
issueKeyand the transition ID inactionDescriptorId. You can obtain the IDs of an issue’s valid transitions using thetransitionsoption in theexpandparameter of [Get issue](#api-rest-api-3-issue-issueIdOrKey-get). In all these cases, you can pass an account ID to determine if a user can be assigned to an issue.
The user is returned in the response if they can be assigned to the issue or issue transition. This operation takes the users in the range defined by startAt and maxResults, up to the thousandth user, and then returns only the users from that range that can be assigned the issue. This means the operation usually returns fewer users than specified in maxResults. To get all the users who can be assigned the issue, use [Get all users](#api-rest-api-3-users-search-get) and filter the records in your code.
Permissions required:
Permission to access Jira.
This operation makes an HTTP GET request to the /rest/api/3/user/assignable/search endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
query |
String |
A query string that is matched against user attributes, such as |
||
Session Id |
String |
The sessionId of this request. SessionId is the same until the assignee is set. |
||
username |
String |
This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details. |
||
Account Id |
String |
A query string that is matched exactly against user |
||
project |
String |
The project ID or project key (case sensitive). Required, unless |
||
Issue Key |
String |
The key of the issue. Required, unless |
||
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return. This operation may return less than the maximum number of items even if more are available. The operation fetches users up to the maximum and then, from the fetched users, returns only the users that can be assigned to the issue. |
50 |
|
Action Descriptor Id |
Number |
The ID of the transition. |
||
recommend |
Boolean |
recommend |
false |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Bulk Get Users
<jira:get-rest-api3-user-bulk>
Returns a paginated list of the users specified by one or more account IDs.
Permissions required:
Permission to access Jira.
This operation makes an HTTP GET request to the /rest/api/3/user/bulk endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
10 |
|
username |
Array of String |
This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details. |
||
key |
Array of String |
This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details. |
||
Account Id |
Array of String |
The account ID of a user. To specify multiple users, pass multiple |
x |
|
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Bulk Get Users Migration
<jira:get-rest-api3-user-bulk-migration>
Returns the account IDs for the users specified in the key or username parameters. Note that multiple key or username parameters can be specified.
Permissions required:
Permission to access Jira.
This operation makes an HTTP GET request to the /rest/api/3/user/bulk/migration endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
10 |
|
username |
Array of String |
Username of a user. To specify multiple users, pass multiple copies of this parameter. For example, |
||
key |
Array of String |
Key of a user. To specify multiple users, pass multiple copies of this parameter. For example, |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get User Default Columns
<jira:get-rest-api3-user-columns>
Returns the default issue table columns for the user. If accountId is not passed in the request, the calling user’s details are returned.
Permissions required:
-
Administer Jira global permission, to get the column details for any user.
-
Permission to access Jira, to get the calling user’s column details.
This operation makes an HTTP GET request to the /rest/api/3/user/columns endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
||
username |
String |
This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get User Email
<jira:get-rest-api3-user-email>
Returns a user’s email address. This API is only available to apps approved by Atlassian, according to these guidelines.
This operation makes an HTTP GET request to the /rest/api/3/user/email endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get User Email Bulk
<jira:get-rest-api3-user-email-bulk>
Returns a user’s email address. This API is only available to apps approved by Atlassian, according to these guidelines.
This operation makes an HTTP GET request to the /rest/api/3/user/email/bulk endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
Array of String |
The account IDs of the users for which emails are required. An |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get User Groups
<jira:get-rest-api3-user-groups>
Returns the groups to which a user belongs.
Permissions required:
Browse users and groups global permission.
This operation makes an HTTP GET request to the /rest/api/3/user/groups endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
x |
|
username |
String |
This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details. |
||
key |
String |
This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Find Users With All Permissions
<jira:get-rest-api3-user-permission-search>
Returns a list of users who fulfill these criteria:
-
their user attributes match a search string.
-
they have a set of permissions for a project or issue.
If no search string is provided, a list of all users with the permissions is returned. This operation takes the users in the range defined by startAt and maxResults, up to the thousandth user, and then returns only the users from that range that match the search string and have permission for the project or issue. This means the operation usually returns fewer users than specified in maxResults. To get all the users who match the search string and have permission for the project or issue, use [Get all users](#api-rest-api-3-users-search-get) and filter the records in your code. This operation can be accessed anonymously.
Permissions required:
-
Administer Jira global permission, to get users for any project.
-
Administer Projects project permission for a project, to get users for that project.
This operation makes an HTTP GET request to the /rest/api/3/user/permission/search endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
query |
String |
A query string that is matched against user attributes, such as |
||
username |
String |
This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details. |
||
Account Id |
String |
A query string that is matched exactly against user |
||
permissions |
String |
A comma-separated list of permissions. Permissions can be specified as any:
|
x |
|
Issue Key |
String |
The issue key for the issue. |
||
Project Key |
String |
The project key for the project (case sensitive). |
||
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
50 |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Find Users For Picker
<jira:get-rest-api3-user-picker>
Returns a list of users whose attributes match the query term. The returned object includes the html field where the matched query term is highlighted with the HTML strong tag. A list of account IDs can be provided to exclude users from the results. This operation takes the users in the range defined by maxResults, up to the thousandth user, and then returns only the users from that range that match the query term. This means the operation usually returns fewer users than specified in maxResults. To get all the users who match the query term, use [Get all users](#api-rest-api-3-users-search-get) and filter the records in your code. This operation can be accessed anonymously.
Permissions required:
Browse users and groups global permission. Anonymous calls and calls by users without the required permission return search results for an exact name match only.
This operation makes an HTTP GET request to the /rest/api/3/user/picker endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
query |
String |
A query string that is matched against user attributes, such as |
x |
|
Max Results |
Number |
The maximum number of items to return. The total number of matched users is returned in |
50 |
|
Show Avatar |
Boolean |
Include the URI to the user’s avatar. |
false |
|
exclude |
Array of String |
This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details. |
||
Exclude Account Ids |
Array of String |
A list of account IDs to exclude from the search results. This parameter accepts a comma-separated list. Multiple account IDs can also be provided using an ampersand-separated list. For example, |
||
Avatar Size |
String |
Avatar Size |
||
Exclude Connect Users |
Boolean |
Exclude Connect Users |
false |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get User Property Keys
<jira:get-rest-api3-user-properties>
Returns the keys of all properties for a user. Note: This operation does not access the user properties created and maintained in Jira.
Permissions required:
-
Administer Jira global permission, to access the property keys on any user.
-
Access to Jira, to access the calling user’s property keys.
This operation makes an HTTP GET request to the /rest/api/3/user/properties endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
||
User Key |
String |
This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details. |
||
username |
String |
This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get User Property
<jira:get-rest-api3-user-properties-by-property-key>
Returns the value of a user’s property. If no property key is provided [Get user property keys](#api-rest-api-3-user-properties-get) is called. Note: This operation does not access the [user properties](https://confluence.atlassian.com/x/8YxjL) created and maintained in Jira.
Permissions required:
-
Administer Jira global permission, to get a property from any user.
-
Access to Jira, to get a property from the calling user’s record.
This operation makes an HTTP GET request to the /rest/api/3/user/properties/{propertyKey} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Property Key |
String |
The key of the user’s property. |
x |
|
Account Id |
String |
The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
||
User Key |
String |
This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. |
||
username |
String |
This parameter is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Find Users
<jira:get-rest-api3-user-search>
Returns a list of users that match the search string and property. This operation takes the users in the range defined by startAt and maxResults, up to the thousandth user, and then returns only the users from that range that match the search string and property. This means the operation usually returns fewer users than specified in maxResults. To get all the users who match the search string and property, use [Get all users](#api-rest-api-3-users-search-get) and filter the records in your code. This operation can be accessed anonymously.
Permissions required:
Browse users and groups global permission. Anonymous calls or calls by users without the required permission return empty search results.
This operation makes an HTTP GET request to the /rest/api/3/user/search endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
query |
String |
A query string that is matched against user attributes ( |
||
username |
String |
username |
||
Account Id |
String |
A query string that is matched exactly against a user |
||
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
50 |
|
property |
String |
A query string used to search properties. Property keys are specified by path, so property keys containing dot (.) or equals (=) characters cannot be used. The query string cannot be specified using a JSON object. Example: To search for the value of |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Find Users By Query
<jira:get-rest-api3-user-search-query>
Finds users with a structured query and returns a paginated list of user details. This operation takes the users in the range defined by startAt and maxResults, up to the thousandth user, and then returns only the users from that range that match the structured query. This means the operation usually returns fewer users than specified in maxResults. To get all the users who match the structured query, use [Get all users](#api-rest-api-3-users-search-get) and filter the records in your code.
Permissions required:
Browse users and groups global permission.
The query statements are:
-
is assignee of PROJReturns the users that are assignees of at least one issue in project PROJ. -
is assignee of (PROJ-1, PROJ-2)Returns users that are assignees on the issues PROJ-1 or PROJ-2. -
is reporter of (PROJ-1, PROJ-2)Returns users that are reporters on the issues PROJ-1 or PROJ-2. -
is watcher of (PROJ-1, PROJ-2)Returns users that are watchers on the issues PROJ-1 or PROJ-2. -
is voter of (PROJ-1, PROJ-2)Returns users that are voters on the issues PROJ-1 or PROJ-2. -
is commenter of (PROJ-1, PROJ-2)Returns users that have posted a comment on the issues PROJ-1 or PROJ-2. -
is transitioner of (PROJ-1, PROJ-2)Returns users that have performed a transition on issues PROJ-1 or PROJ-2. -
[propertyKey].entity.property.path is "property value"Returns users with the entity property value.
The list of issues can be extended as needed, as in (PROJ-1, PROJ-2, … PROJ-n). Statements can be combined using the AND and OR operators to form more complex queries. For example: is assignee of PROJ AND [propertyKey].entity.property.path is "property value"
This operation makes an HTTP GET request to the /rest/api/3/user/search/query endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
query |
String |
The search query. |
x |
|
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
100 |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Find User Keys By Query
<jira:get-rest-api3-user-search-query-key>
Finds users with a structured query and returns a paginated list of user keys. This operation takes the users in the range defined by startAt and maxResults, up to the thousandth user, and then returns only the users from that range that match the structured query. This means the operation usually returns fewer users than specified in maxResults. To get all the users who match the structured query, use [Get all users](#api-rest-api-3-users-search-get) and filter the records in your code.
Permissions required:
Browse users and groups global permission.
The query statements are:
-
is assignee of PROJReturns the users that are assignees of at least one issue in project PROJ. -
is assignee of (PROJ-1, PROJ-2)Returns users that are assignees on the issues PROJ-1 or PROJ-2. -
is reporter of (PROJ-1, PROJ-2)Returns users that are reporters on the issues PROJ-1 or PROJ-2. -
is watcher of (PROJ-1, PROJ-2)Returns users that are watchers on the issues PROJ-1 or PROJ-2. -
is voter of (PROJ-1, PROJ-2)Returns users that are voters on the issues PROJ-1 or PROJ-2. -
is commenter of (PROJ-1, PROJ-2)Returns users that have posted a comment on the issues PROJ-1 or PROJ-2. -
is transitioner of (PROJ-1, PROJ-2)Returns users that have performed a transition on issues PROJ-1 or PROJ-2. -
[propertyKey].entity.property.path is "property value"Returns users with the entity property value.
The list of issues can be extended as needed, as in (PROJ-1, PROJ-2, … PROJ-n). Statements can be combined using the AND and OR operators to form more complex queries. For example: is assignee of PROJ AND [propertyKey].entity.property.path is "property value"
This operation makes an HTTP GET request to the /rest/api/3/user/search/query/key endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
query |
String |
The search query. |
x |
|
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
100 |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Find Users With Browse Permission
<jira:get-rest-api3-user-viewissue-search>
Returns a list of users who fulfill these criteria:
-
their user attributes match a search string.
-
they have permission to browse issues.
Use this resource to find users who can browse:
-
an issue, by providing the
issueKey. -
any issue in a project, by providing the
projectKey. This operation takes the users in the range defined bystartAtandmaxResults, up to the thousandth user, and then returns only the users from that range that match the search string and have permission to browse issues. This means the operation usually returns fewer users than specified inmaxResults. To get all the users who match the search string and have permission to browse issues, use [Get all users](#api-rest-api-3-users-search-get) and filter the records in your code.
This operation can be accessed anonymously.
Permissions required:
Browse users and groups global permission. Anonymous calls and calls by users without the required permission return empty search results.
This operation makes an HTTP GET request to the /rest/api/3/user/viewissue/search endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
query |
String |
A query string that is matched against user attributes, such as |
||
username |
String |
This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details. |
||
Account Id |
String |
A query string that is matched exactly against user |
||
Issue Key |
String |
The issue key for the issue. Required, unless |
||
Project Key |
String |
The project key for the project (case sensitive). Required, unless |
||
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
50 |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get All Users Default
<jira:get-rest-api3-users>
Returns a list of all (active and inactive) users.
Permissions required:
Browse users and groups global permission
This operation makes an HTTP GET request to the /rest/api/3/users endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Start At |
Number |
The index of the first item to return. |
0 |
|
Max Results |
Number |
The maximum number of items to return. |
50 |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get All Users
<jira:get-rest-api3-users-search>
Returns a list of all (active and inactive) users.
Permissions required:
Browse users and groups global permission.
This operation makes an HTTP GET request to the /rest/api/3/users/search endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Start At |
Number |
The index of the first item to return. |
0 |
|
Max Results |
Number |
The maximum number of items to return. |
50 |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Version
<jira:get-rest-api3-version-by-id>
Returns a project version. This operation can be accessed anonymously.
Permissions required:
Browse projects project permission for the project containing the version.
This operation makes an HTTP GET request to the /rest/api/3/version/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
The ID of the version. |
x |
|
expand |
String |
Use
|
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Version Related Issues
<jira:get-rest-api3-version-related-issue-counts-by-id>
Returns the following counts for a version:
-
Number of issues where the
fixVersionis set to the version. -
Number of issues where the
affectedVersionis set to the version. -
Number of issues where a version custom field is set to the version.
This operation can be accessed anonymously.
Permissions required:
Browse projects project permission for the project that contains the version.
This operation makes an HTTP GET request to the /rest/api/3/version/{id}/relatedIssueCounts endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
The ID of the version. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Version Unresolved Issues
<jira:get-rest-api3-version-unresolved-issue-count-by-id>
Returns counts of the issues and unresolved issues for the project version. This operation can be accessed anonymously.
Permissions required:
Browse projects project permission for the project that contains the version.
This operation makes an HTTP GET request to the /rest/api/3/version/{id}/unresolvedIssueCount endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
The ID of the version. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Dynamic Webhooks For App
<jira:get-rest-api3-webhook>
Returns a paginated list of the webhooks registered by the calling app.
Permissions required:
Only Connect apps can use this operation.
This operation makes an HTTP GET request to the /rest/api/3/webhook endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
100 |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Failed Webhooks
<jira:get-rest-api3-webhook-failed>
Returns webhooks that have recently failed to be delivered to the requesting app after the maximum number of retries. After 72 hours the failure may no longer be returned by this operation. The oldest failure is returned first. This method uses a cursor-based pagination. To request the next page use the failure time of the last webhook on the list as the failedAfter value or use the URL provided in next.
Permissions required:
Only Connect apps can use this operation.
This operation makes an HTTP GET request to the /rest/api/3/webhook/failed endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Max Results |
Number |
The maximum number of webhooks to return per page. If obeying the maxResults directive would result in records with the same failure time being split across pages, the directive is ignored and all records with the same failure time included on the page. |
||
after |
Number |
The time after which any webhook failure must have occurred for the record to be returned, expressed as milliseconds since the UNIX epoch. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Workflow Transition Rule Configurations
<jira:get-rest-api3-workflow-rule-config>
Returns a paginated list of workflows with transition rules. The workflows can be filtered to return only those containing workflow transition rules:
-
of one or more transition rule types, such as workflow post functions.
-
matching one or more transition rule keys. Only workflows containing transition rules created by the calling Connect app are returned. However, if a workflow is returned all transition rules that match the filters are returned for that workflow. Due to server-side optimizations, workflows with an empty list of rules may be returned; these workflows can be ignored.
Permissions required:
Only Connect apps can use this operation.
This operation makes an HTTP GET request to the /rest/api/3/workflow/rule/config endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
10 |
|
types |
Array of Enumeration, one of:
|
The types of the transition rules to return. |
x |
|
keys |
Array of String |
The transition rule class keys, as defined in the Connect app descriptor, of the transition rules to return. |
||
expand |
String |
Use |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Workflows Paginated
<jira:get-rest-api3-workflow-search>
Returns a paginated list of published classic workflows. When workflow names are specified, details of those workflows are returned. Otherwise, all published classic workflows are returned. This operation does not return next-gen workflows.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/workflow/search endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
50 |
|
Workflow Name |
Array of String |
The name of a workflow to return. |
||
expand |
String |
Use
|
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Workflow Transition Properties
<jira:get-rest-api3-workflow-transitions-properties-by-transition-id>
Returns the properties on a workflow transition. Transition properties are used to change the behavior of a transition. For more information, see Transition properties and Workflow properties.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/workflow/transitions/{transitionId}/properties endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Transition Id |
Number |
The ID of the transition. To get the ID, view the workflow in text mode in the Jira administration console. The ID is shown next to the transition. |
x |
|
Include Reserved Keys |
Boolean |
Some properties with keys that have the jira. prefix are reserved, which means they are not editable. To include these properties in the results, set this parameter to true. |
false |
|
key |
String |
The key of the property being returned, also known as the name of the property. If this parameter is not specified, all properties on the transition are returned. |
||
Workflow Name |
String |
The name of the workflow that the transition belongs to. |
x |
|
Workflow Mode |
Enumeration, one of:
|
The workflow status. Set to live for active and inactive workflows, or draft for draft workflows. |
LIVE |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get All Workflow Schemes
<jira:get-rest-api3-workflowscheme>
Returns a paginated list of all workflow schemes, not including draft workflow schemes.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/workflowscheme endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Start At |
Number |
The index of the first item to return in a page of results (page offset). |
0 |
|
Max Results |
Number |
The maximum number of items to return per page. |
50 |
|
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Workflow Scheme
<jira:get-rest-api3-workflowscheme-by-id>
Returns a workflow scheme.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/workflowscheme/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the workflow scheme. Find this ID by editing the desired workflow scheme in Jira. The ID is shown in the URL as |
x |
|
Return Draft If Exists |
Boolean |
Returns the workflow scheme’s draft rather than scheme itself, if set to true. If the workflow scheme does not have a draft, then the workflow scheme is returned. |
false |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Default Workflow
<jira:get-rest-api3-workflowscheme-default-by-id>
Returns the default workflow for a workflow scheme. The default workflow is the workflow that is assigned any issue types that have not been mapped to any other workflow. The default workflow has All Unassigned Issue Types listed in its issue types for the workflow scheme in Jira.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/workflowscheme/{id}/default endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the workflow scheme. |
x |
|
Return Draft If Exists |
Boolean |
Set to |
false |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Workflow Scheme Draft
<jira:get-rest-api3-workflowscheme-draft-by-id>
Returns the draft workflow scheme for an active workflow scheme. Draft workflow schemes allow changes to be made to the active workflow schemes: When an active workflow scheme is updated, a draft copy is created. The draft is modified, then the changes in the draft are copied back to the active workflow scheme. See Configuring workflow schemes for more information.
Note:
-
Only active workflow schemes can have draft workflow schemes.
-
An active workflow scheme can only have one draft workflow scheme.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/workflowscheme/{id}/draft endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the active workflow scheme that the draft was created from. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Draft Default Workflow
<jira:get-rest-api3-workflowscheme-draft-default-by-id>
Returns the default workflow for a workflow scheme’s draft. The default workflow is the workflow that is assigned any issue types that have not been mapped to any other workflow. The default workflow has All Unassigned Issue Types listed in its issue types for the workflow scheme in Jira.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/workflowscheme/{id}/draft/default endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the workflow scheme that the draft belongs to. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Workflow Scheme Draft Issue Type
<jira:get-rest-api3-workflowscheme-draft-issuetype-by-id-issue-type>
Returns the issue type-workflow mapping for an issue type in a workflow scheme’s draft.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/workflowscheme/{id}/draft/issuetype/{issueType} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the workflow scheme that the draft belongs to. |
x |
|
Issue Type |
String |
The ID of the issue type. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Draft Workflow
<jira:get-rest-api3-workflowscheme-draft-workflow-by-id>
Returns the workflow-issue type mappings for a workflow scheme’s draft.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/workflowscheme/{id}/draft/workflow endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the workflow scheme that the draft belongs to. |
x |
|
Workflow Name |
String |
The name of a workflow in the scheme. Limits the results to the workflow-issue type mapping for the specified workflow. |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Workflow Scheme Issue Type
<jira:get-rest-api3-workflowscheme-issuetype-by-id-issue-type>
Returns the issue type-workflow mapping for an issue type in a workflow scheme.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/workflowscheme/{id}/issuetype/{issueType} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the workflow scheme. |
x |
|
Issue Type |
String |
The ID of the issue type. |
x |
|
Return Draft If Exists |
Boolean |
Returns the mapping from the workflow scheme’s draft rather than the workflow scheme, if set to true. If no draft exists, the mapping from the workflow scheme is returned. |
false |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Workflow Scheme Project Associations
<jira:get-rest-api3-workflowscheme-project>
Returns a list of the workflow schemes associated with a list of projects. Each returned workflow scheme includes a list of the requested projects associated with it. Any next-gen or non-existent projects in the request are ignored and no errors are returned.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/workflowscheme/project endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Project Id |
Array of Number |
The ID of a project to return the workflow schemes for. To include multiple projects, provide an ampersand-Jim: oneseparated list. For example, |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Workflow
<jira:get-rest-api3-workflowscheme-workflow-by-id>
Returns the workflow-issue type mappings for a workflow scheme.
Permissions required:
Administer Jira global permission
This operation makes an HTTP GET request to the /rest/api/3/workflowscheme/{id}/workflow endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the workflow scheme. |
x |
|
Workflow Name |
String |
The name of a workflow in the scheme. Limits the results to the workflow-issue type mapping for the specified workflow. |
||
Return Draft If Exists |
Boolean |
Returns the mapping from the workflow scheme’s draft rather than the workflow scheme, if set to true. If no draft exists, the mapping from the workflow scheme is returned. |
false |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Ids Of Worklogs Deleted Since
<jira:get-rest-api3-worklog-deleted>
Returns a list of IDs and delete timestamps for worklogs deleted after a date and time. This resource is paginated, with a limit of 1000 worklogs per page. Each page lists worklogs from oldest to youngest. If the number of items in the date range exceeds 1000, until indicates the timestamp of the youngest item on the page. Also, nextPage provides the URL for the next page of worklogs. The lastPage parameter is set to true on the last page of worklogs. This resource does not return worklogs deleted during the minute preceding the request.
Permissions required:
Permission to access Jira.
This operation makes an HTTP GET request to the /rest/api/3/worklog/deleted endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
since |
Number |
The date and time, as a UNIX timestamp in milliseconds, after which deleted worklogs are returned. |
0 |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Get Ids Of Worklogs Modified Since
<jira:get-rest-api3-worklog-updated>
Returns a list of IDs and update timestamps for worklogs updated after a date and time. This resource is paginated, with a limit of 1000 worklogs per page. Each page lists worklogs from oldest to youngest. If the number of items in the date range exceeds 1000, until indicates the timestamp of the youngest item on the page. Also, nextPage provides the URL for the next page of worklogs. The lastPage parameter is set to true on the last page of worklogs. This resource does not return worklogs updated during the minute preceding the request.
Permissions required:
Permission to access Jira, however, worklogs are only returned where either of the following is true:
-
the worklog is set as Viewable by All Users.
-
the user is a member of a project role or group with permission to view the worklog.
This operation makes an HTTP GET request to the /rest/api/3/worklog/updated endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
since |
Number |
The date and time, as a UNIX timestamp in milliseconds, after which updated worklogs are returned. |
0 |
|
expand |
String |
Use |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Addon Properties Resource get Addon Properties get
<jira:get-rest-atlassian-connect1-addons-properties-by-addon-key>
Gets all the properties of an app.
Permissions required:
Only a Connect app whose key matches addonKey can make this request.
This operation makes an HTTP GET request to the /rest/atlassian-connect/1/addons/{addonKey}/properties endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Addon Key |
String |
The key of the app, as defined in its descriptor. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Addon Properties Resource get Addon Property get
<jira:get-rest-atlassian-connect1-addons-properties-by-addon-key-property-key>
Returns the key and value of an app’s property.
Permissions required:
Only a Connect app whose key matches addonKey can make this request.
This operation makes an HTTP GET request to the /rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Addon Key |
String |
The key of the app, as defined in its descriptor. |
x |
|
Property Key |
String |
The key of the property. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Dynamic Modules Resource get Modules get
<jira:get-rest-atlassian-connect1-app-module-dynamic>
Returns all modules registered dynamically by the calling app.
Permissions required:
Only Connect apps can make this request.
This operation makes an HTTP GET request to the /rest/atlassian-connect/1/app/module/dynamic endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Unauthorize
<jira:unauthorize>
Deletes all the access token information of a given resource owner ID so that it’s impossible to execute any operation for that user without repeating the authorization dance.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Resource Owner Id |
String |
The id of the resource owner which access should be invalidated |
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
Set Application Property
<jira:update-rest-api3-application-properties-by-id>
Changes the value of an application property. For example, you can change the value of the jira.clone.prefix from its default value of CLONE - to Clone - if you prefer sentence case capitalization. Editable properties are described below along with their default values.
Advanced settings
The advanced settings below are also accessible in Jira:
| Key | Description | Default value |
|---|---|---|
|
The string of text prefixed to the title of a cloned issue. |
|
|
The date format for the Java (server-side) generated dates. This must be the same as the |
|
|
The date format for the JavaScript (client-side) generated dates. This must be the same as the |
|
|
The date format for the Java (server-side) generated date times. This must be the same as the |
|
|
The date format for the JavaScript (client-side) generated date times. This must be the same as the |
|
|
The default order of actions (such as Comments or Change history) displayed on the issue view. |
|
|
The columns to show while viewing subtask issues in a table. For example, a list of subtasks on an issue. |
|
|
The sort order of the list of issue links on the issue view. |
|
|
The minimum number of comments required for comment collapsing to occur. A value of |
|
|
The number of days before a prompt to sign up to the Jira Insiders newsletter is shown. A value of |
|
Look and feel
The settings listed below adjust the look and feel:
| Key | Description | Default value |
|---|---|---|
|
The time format. |
|
|
The day format. |
|
|
The date and time format. |
|
|
The date format. |
|
|
When enabled, sets Monday as the first day of the week in the date picker, as specified by the ISO8601 standard. |
|
|
The URL of the logo image file. |
|
|
Controls the visibility of the application title on the sidebar. |
|
|
The URL of the favicon. |
|
|
The URL of the high-resolution favicon. |
|
|
The background color of the sidebar. |
|
|
The color of the text and logo of the sidebar. |
|
|
The background color of the hero button. |
|
|
The text for the application title. The application title can also be set in General settings. |
|
|
Whether filters and dashboards can be shared with anyone signed into Jira. |
|
|
Whether to expose product suggestions for other Atlassian products within Jira. |
|
Other settings
| Key | Description | Default value |
|---|---|---|
|
Whether instant updates to search criteria is active. |
|
Note: Be careful when changing application properties and advanced settings.
Permissions required:
Administer Jira global permission.
This operation makes an HTTP PUT request to the /rest/api/3/application-properties/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
The key of the application property to update. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Set Comment Property
<jira:update-rest-api3-comment-properties-by-comment-id-property-key>
Creates or updates the value of a property for a comment. Use this resource to store custom data against a comment. The value of the request body must be a [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum length is 32768 characters.
Permissions required:
Either of:
-
Edit All Comments project permission to create or update the value of a property on any comment.
-
Edit Own Comments project permission to create or update the value of a property on a comment created by the user. Also, when the visibility of a comment is restricted to a role or group the user must be a member of that role or group.
This operation makes an HTTP PUT request to the /rest/api/3/comment/{commentId}/properties/{propertyKey} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Comment Id |
String |
The ID of the comment. |
x |
|
Property Key |
String |
The key of the property. The maximum length is 255 characters. |
x |
|
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update Component
<jira:update-rest-api3-component-by-id>
Updates a component. Any fields included in the request are overwritten. If leadAccountId is an empty string ("") the component lead is removed. This operation can be accessed anonymously.
Permissions required:
Administer projects project permission for the project containing the component or Administer Jira global permission.
This operation makes an HTTP PUT request to the /rest/api/3/component/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
The ID of the component. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Select Time Tracking Implementation
<jira:update-rest-api3-configuration-timetracking>
Selects a time tracking provider.
Permissions required:
Administer Jira global permission
This operation makes an HTTP PUT request to the /rest/api/3/configuration/timetracking endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Set Shared Time Tracking Configuration
<jira:update-rest-api3-configuration-timetracking-options>
Sets the time tracking settings.
Permissions required:
Administer Jira global permission
This operation makes an HTTP PUT request to the /rest/api/3/configuration/timetracking/options endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update Custom Field Options
<jira:update-rest-api3-custom-field-option-by-field-id>
This operation is deprecated and becomes unavailable on 8 May 2021. Use Update custom field options (context) instead. See Deprecation of custom field options for details.
Updates the options on a custom select field. Where an updated option is in use on an issue, the value on the issue is also updated. Options that are not found are ignored. A maximum of 1000 options, including sub-options of Select List (cascading) fields, can be updated per request. The options are updated on the global context of the field. Note that this operation only works for issue field select list options created in Jira or using operations from the [Issue custom field options](api-group-Issue-custom-field-options) resource, it cannot be used with issue field select list options created by Connect apps.
Permissions required:
Administer Jira global permission
This operation makes an HTTP PUT request to the /rest/api/3/customField/{fieldId}/option endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Field Id |
Number |
The ID of the custom field. Note: This is the numeric part of the of the field ID. For example, for a field with the ID customfield\_10075 use 10075. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update Dashboard
<jira:update-rest-api3-dashboard-by-id>
Updates a dashboard, replacing all the dashboard details with those provided.
Permissions required:
None
The dashboard to be updated must be owned by the user.
This operation makes an HTTP PUT request to the /rest/api/3/dashboard/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
The ID of the dashboard to update. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Set Dashboard Item Property
<jira:update-rest-api3-dashboard-items-properties-by-dashboard-id-item-id-property-key>
Sets the value of a dashboard item property. Use this resource in apps to store custom data against a dashboard item. A dashboard item enables an app to add user-specific information to a user dashboard. Dashboard items are exposed to users as gadgets that users can add to their dashboards. For more information on how users do this, see Adding and customizing gadgets.
When an app creates a dashboard item, it registers a callback to receive the dashboard item ID. The callback fires whenever the item is rendered or, where the item is configurable, the user edits the item. The app then uses this resource to store the item’s content or configuration details. For more information on working with dashboard items, see Building a dashboard item for a JIRA Connect add-on and the Dashboard Item documentation.
There is no resource to set or get dashboard items. The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.
This operation can be accessed anonymously.
Permissions required:
The user must be the owner of the dashboard. Note, users with the Administer Jira global permission are considered owners of the System dashboard.
This operation makes an HTTP PUT request to the /rest/api/3/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Dashboard Id |
String |
The ID of the dashboard. |
x |
|
Item Id |
String |
The ID of the dashboard item. |
x |
|
Property Key |
String |
The key of the dashboard item property. The maximum length is 255 characters. |
x |
|
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update Custom Field
<jira:update-rest-api3-field-by-field-id>
Updates a custom field.
Permissions required:
Administer Jira global permission
This operation makes an HTTP PUT request to the /rest/api/3/field/{fieldId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Field Id |
String |
The ID of the custom field. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update Custom Field Context
<jira:update-rest-api3-field-context-by-field-id-context-id>
Updates a custom field context.
Permissions required:
Administer Jira global permission
This operation makes an HTTP PUT request to the /rest/api/3/field/{fieldId}/context/{contextId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Field Id |
String |
The ID of the custom field. |
x |
|
Context Id |
Number |
The ID of the context. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Set Default Values
<jira:update-rest-api3-field-context-default-value-by-field-id>
Sets default for contexts of a custom field. Default are defined using these objects:
-
CustomFieldContextDefaultValueSingleOption(typeoption.single) for single choice select lists and radio buttons. -
CustomFieldContextDefaultValueMultipleOption(typeoption.multiple) for multiple choice select lists and checkboxes. -
CustomFieldContextDefaultValueCascadingOption(typeoption.cascading) for cascading select lists. Only one type of default object can be included in a request. To remove a default for a context, set the default parameter tonull.
Permissions required:
Administer Jira global permission
This operation makes an HTTP PUT request to the /rest/api/3/field/{fieldId}/context/defaultValue endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Field Id |
String |
The ID of the custom field. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Add Issue Types To Context
<jira:update-rest-api3-field-context-issuetype-by-field-id-context-id>
Adds issue types to a custom field context, appending the issue types to the issue types list. A custom field context without any issue types applies to all issue types. Adding issue types to such a custom field context would result in it applying to only the listed issue types. If any of the issue types exists in the custom field context, the operation fails and no issue types are added.
Permissions required:
Administer Jira global permission
This operation makes an HTTP PUT request to the /rest/api/3/field/{fieldId}/context/{contextId}/issuetype endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Field Id |
String |
The ID of the custom field. |
x |
|
Context Id |
Number |
The ID of the context. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update Custom Field Option
<jira:update-rest-api3-field-context-option-by-field-id-context-id>
Updates the options of a custom field. If any of the options are not found, no options are updated. Options where the values in the request match the current values aren’t updated and aren’t reported in the response. Note that this operation only works for issue field select list options created in Jira or using operations from the [Issue custom field options](#api-group-Issue-custom-field-options) resource, it cannot be used with issue field select list options created by Connect apps.
Permissions required:
Administer Jira global permission.
This operation makes an HTTP PUT request to the /rest/api/3/field/{fieldId}/context/{contextId}/option endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Field Id |
String |
The ID of the custom field. |
x |
|
Context Id |
Number |
The ID of the context. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Reorder Custom Field Options
<jira:update-rest-api3-field-context-option-move-by-field-id-context-id>
Changes the order of custom field options or cascading options in a context. This operation works for custom field options created in Jira or the operations from this resource. To work with issue field select list options created for Connect apps use the [Issue custom field options (apps)](#api-group-issue-custom-field-options—apps-) operations.
Permissions required:
Administer Jira global permission
This operation makes an HTTP PUT request to the /rest/api/3/field/{fieldId}/context/{contextId}/option/move endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Field Id |
String |
The ID of the custom field. |
x |
|
Context Id |
Number |
The ID of the context. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Assign Projects To Custom Field Context
<jira:update-rest-api3-field-context-project-by-field-id-context-id>
Assigns a custom field context to projects. If any project in the request is assigned to any context of the custom field, the operation fails.
Permissions required:
Administer Jira global permission.
This operation makes an HTTP PUT request to the /rest/api/3/field/{fieldId}/context/{contextId}/project endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Field Id |
String |
The ID of the custom field. |
x |
|
Context Id |
Number |
The ID of the context. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update Issue Field Option
<jira:update-rest-api3-field-option-by-field-key-option-id>
Updates or creates an option for a select list issue field. This operation requires that the option ID is provided when creating an option, therefore, the option ID needs to be specified as a path and body parameter. The option ID provided in the path and body must be identical. Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the [Issue custom field options](api-group-Issue-custom-field-options) resource.
Permissions required:
Administer Jira global permission.
Jira permissions are not required for the app providing the field.
This operation makes an HTTP PUT request to the /rest/api/3/field/{fieldKey}/option/{optionId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Field Key |
String |
The field key is specified in the following format: $(app-key)_\_$(field-key). For example, example-add-on\_\_example-issue-field. To determine the
|
x |
|
Option Id |
Number |
The ID of the option to be updated. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Assign Field Configuration Scheme To Project
<jira:update-rest-api3-fieldconfigurationscheme-project>
Assigns a field configuration scheme to a project. If the field configuration scheme ID is null, the operation assigns the default field configuration scheme. Field configuration schemes can only be assigned to classic projects.
Permissions required:
Administer Jira global permission
This operation makes an HTTP PUT request to the /rest/api/3/fieldconfigurationscheme/project endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update Filter
<jira:update-rest-api3-filter-by-id>
Updates a filter. Use this operation to update a filter’s name, description, JQL, or sharing.
Permissions required:
Permission to access Jira, however the user must own the filter.
This operation makes an HTTP PUT request to the /rest/api/3/filter/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the filter to update. |
x |
|
expand |
String |
Use
|
||
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Set Columns
<jira:update-rest-api3-filter-columns-by-id>
Sets the columns for a filter. Only navigable fields can be set as columns. Use [Get fields](#api-rest-api-3-field-get) to get the list fields in Jira. A navigable field has navigable set to true. The parameters for this resource are expressed as HTML form data. For example, in curl: curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/3/filter/10000/columns
Permissions required:
Permission to access Jira, however, columns are only set for:
-
filters owned by the user.
-
filters shared with a group that the user is a member of.
-
filters shared with a private project that the user has Browse projects project permission for.
-
filters shared with a public project.
-
filters shared with the public.
This operation makes an HTTP PUT request to the /rest/api/3/filter/{id}/columns endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the filter. |
x |
|
Body |
Array of String |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Set Default Share Scope
<jira:update-rest-api3-filter-default-share-scope>
Sets the default sharing for new filters and dashboards for a user.
Permissions required:
Permission to access Jira.
This operation makes an HTTP PUT request to the /rest/api/3/filter/defaultShareScope endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Set Favourite For Filter
<jira:update-rest-api3-filter-favourite-by-id>
Add a filter as a favorite for the user.
Permissions required:
Permission to access Jira, however, the user can only favorite:
-
filters owned by the user.
-
filters shared with a group that the user is a member of.
-
filters shared with a private project that the user has Browse projects project permission for.
-
filters shared with a public project.
-
filters shared with the public.
This operation makes an HTTP PUT request to the /rest/api/3/filter/{id}/favourite endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the filter. |
x |
|
expand |
String |
Use
|
||
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Assign Issue
<jira:update-rest-api3-issue-assignee-by-issue-id-or-key>
Assigns an issue to a user. Use this operation when the calling user does not have the Edit Issues permission but has the Assign issue permission for the project that the issue is in. If name or accountId is set to:
-
"-1", the issue is assigned to the default assignee for the project. -
null, the issue is set to unassigned. This operation can be accessed anonymously.
Permissions required:
-
Browse Projects and Assign Issues [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.
-
If issue-level security is configured, issue-level security permission to view the issue.
This operation makes an HTTP PUT request to the /rest/api/3/issue/{issueIdOrKey}/assignee endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Id Or Key |
String |
The ID or key of the issue to be assigned. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Edit Issue
<jira:update-rest-api3-issue-by-issue-id-or-key>
Edits an issue. A transition may be applied and issue properties updated as part of the edit. The edits to the issue’s fields are defined using update and fields. The fields that can be edited are determined using [Get edit issue metadata](#api-rest-api-3-issue-issueIdOrKey-editmeta-get). The parent field may be set by key or ID. For standard issue types, the parent may be removed by setting update.parent.set.none to true. Note that the description, environment, and any textarea type custom fields (multi-line text fields) take Atlassian Document Format content. Single line custom fields (textfield) accept a string and don’t handle Atlassian Document Format content. Connect app users with admin permissions (from user permissions and app scopes) can override the screen security configuration using overrideScreenSecurity and overrideEditableFlag. This operation can be accessed anonymously.
Permissions required:
-
Browse projects and Edit issues project permission for the project that the issue is in.
-
If issue-level security is configured, issue-level security permission to view the issue.
This operation makes an HTTP PUT request to the /rest/api/3/issue/{issueIdOrKey} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Id Or Key |
String |
The ID or key of the issue. |
x |
|
Notify Users |
Boolean |
Whether a notification email about the issue update is sent to all watchers. To disable the notification, administer Jira or administer project permissions are required. If the user doesn’t have the necessary permission the request is ignored. |
true |
|
Override Screen Security |
Boolean |
Whether screen security should be overridden to enable hidden fields to be edited. Available to Connect app users with admin permissions. |
false |
|
Override Editable Flag |
Boolean |
Whether screen security should be overridden to enable uneditable fields to be edited. Available to Connect app users with admin permissions. |
false |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update Comment
<jira:update-rest-api3-issue-comment-by-issue-id-or-key-id>
Updates a comment. This operation can be accessed anonymously.
Permissions required:
-
Browse projects project permission for the project that the issue containing the comment is in.
-
If issue-level security is configured, issue-level security permission to view the issue.
-
Edit all comments[project permission](https://confluence.atlassian.com/x/yodKLg) to update any comment or Edit own comments to update comment created by the user.
-
If the comment has visibility restrictions, the user belongs to the group or has the role visibility is restricted to.
This operation makes an HTTP PUT request to the /rest/api/3/issue/{issueIdOrKey}/comment/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Id Or Key |
String |
The ID or key of the issue. |
x |
|
id |
String |
The ID of the comment. |
x |
|
expand |
String |
Use |
||
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update Issue Link Type
<jira:update-rest-api3-issue-link-type-by-issue-link-type-id>
Updates an issue link type. To use this operation, the site must have issue linking enabled.
Permissions required:
Administer Jira global permission
This operation makes an HTTP PUT request to the /rest/api/3/issueLinkType/{issueLinkTypeId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Link Type Id |
String |
The ID of the issue link type. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Set Issue Property
<jira:update-rest-api3-issue-properties-by-issue-id-or-key-property-key>
Sets the value of an issue’s property. Use this resource to store custom data against an issue. The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters. This operation can be accessed anonymously.
Permissions required:
-
Browse projects and Edit issues [project permissions](https://confluence.atlassian.com/x/yodKLg) for the project containing the issue.
-
If issue-level security is configured, issue-level security permission to view the issue.
This operation makes an HTTP PUT request to the /rest/api/3/issue/{issueIdOrKey}/properties/{propertyKey} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Id Or Key |
String |
The ID or key of the issue. |
x |
|
Property Key |
String |
The key of the issue property. The maximum length is 255 characters. |
x |
|
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Bulk Set Issue Property
<jira:update-rest-api3-issue-properties-by-property-key>
Sets a property value on multiple issues. The value set can be a constant or determined by a Jira expression. Expressions must be computable with constant complexity when applied to a set of issues. Expressions must also comply with the restrictions that apply to all Jira expressions. The issues to be updated can be specified by a filter. The filter identifies issues eligible for update using these criteria:
-
entityIdsOnly issues from this list are eligible. -
currentValueOnly issues with the property set to this value are eligible. -
hasProperty: * If true, only issues with the property are eligible. -
If false, only issues without the property are eligible. If more than one criteria is specified, they are joined with the logical AND: only issues that satisfy all criteria are eligible. If an invalid combination of criteria is provided, an error is returned. For example, specifying a
currentValueandhasPropertyas false would not match any issues (because without the property the property cannot have a value).
The filter is optional. Without the filter all the issues visible to the user and where the user has the EDIT\_ISSUES permission for the issue are considered eligible. This operation is:
-
transactional, either all eligible issues are updated or, when errors occur, none are updated.
-
[asynchronous](#async). Follow the
locationlink in the response to determine the status of the task and use [Get task](#api-rest-api-3-task-taskId-get) to obtain subsequent updates.
Permissions required:
-
Browse projects project permission for each project containing issues.
-
If issue-level security is configured, issue-level security permission to view the issue.
-
Edit issues project permission for each issue.
This operation makes an HTTP PUT request to the /rest/api/3/issue/properties/{propertyKey} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Property Key |
String |
The key of the property. The maximum length is 255 characters. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update Remote Issue Link
<jira:update-rest-api3-issue-remotelink-by-issue-id-or-key-link-id>
Updates a remote issue link for an issue. Note: Fields without values in the request are set to null. This operation requires [issue linking to be active](https://confluence.atlassian.com/x/yoXKM). This operation can be accessed anonymously.
Permissions required:
-
Browse projects and Link issues project permission for the project that the issue is in.
-
If issue-level security is configured, issue-level security permission to view the issue.
This operation makes an HTTP PUT request to the /rest/api/3/issue/{issueIdOrKey}/remotelink/{linkId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Id Or Key |
String |
The ID or key of the issue. |
x |
|
Link Id |
String |
The ID of the remote issue link. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update Worklog
<jira:update-rest-api3-issue-worklog-by-issue-id-or-key-id>
Updates a worklog. Time tracking must be enabled in Jira, otherwise this operation returns an error. For more information, see Configuring time tracking. This operation can be accessed anonymously.
Permissions required:
-
Browse projects project permission for the project that the issue is in.
-
If issue-level security is configured, issue-level security permission to view the issue.
-
Edit all worklogs project permission to update any worklog or Edit own worklogs to update worklogs created by the user.
-
If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
This operation makes an HTTP PUT request to the /rest/api/3/issue/{issueIdOrKey}/worklog/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Id Or Key |
String |
The ID or key the issue. |
x |
|
id |
String |
The ID of the worklog. |
x |
|
Notify Users |
Boolean |
Whether users watching the issue are notified by email. |
true |
|
Adjust Estimate |
Enumeration, one of:
|
Defines how to update the issue’s time estimate, the options are:
|
AUTO |
|
New Estimate |
String |
The value to set as the issue’s remaining time estimate, as days (#d), hours (\#h), or minutes (\#m or \#). For example, 2d. Required when |
||
expand |
String |
Use |
||
Override Editable Flag |
Boolean |
Whether the worklog should be added to the issue even if the issue is not editable. For example, because the issue is closed. Only connect app users with admin permissions can use this flag. |
false |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Set Worklog Property
<jira:update-rest-api3-issue-worklog-properties-by-issue-id-or-key-worklog-id-property-key>
Sets the value of a worklog property. Use this operation to store custom data against the worklog. The value of the request body must be a [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum length is 32768 characters. This operation can be accessed anonymously.
Permissions required:
-
Browse projects project permission for the project that the issue is in.
-
If issue-level security is configured, issue-level security permission to view the issue.
-
Edit all worklogs[ project permission](https://confluence.atlassian.com/x/yodKLg) to update any worklog or Edit own worklogs to update worklogs created by the user.
-
If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
This operation makes an HTTP PUT request to the /rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties/{propertyKey} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Id Or Key |
String |
The ID or key of the issue. |
x |
|
Worklog Id |
String |
The ID of the worklog. |
x |
|
Property Key |
String |
The key of the issue property. The maximum length is 255 characters. |
x |
|
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update Issue Type
<jira:update-rest-api3-issuetype-by-id>
Updates the issue type.
Permissions required:
Administer Jira global permission
This operation makes an HTTP PUT request to the /rest/api/3/issuetype/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
The ID of the issue type. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Set Issue Type Property
<jira:update-rest-api3-issuetype-properties-by-issue-type-id-property-key>
Creates or updates the value of the issue type property. Use this resource to store and update data against an issue type. The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.
Permissions required:
Administer Jira global permission
This operation makes an HTTP PUT request to the /rest/api/3/issuetype/{issueTypeId}/properties/{propertyKey} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Type Id |
String |
The ID of the issue type. |
x |
|
Property Key |
String |
The key of the issue type property. The maximum length is 255 characters. |
x |
|
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update Issue Type Scheme
<jira:update-rest-api3-issuetypescheme-by-issue-type-scheme-id>
Updates an issue type scheme.
Permissions required:
Administer Jira global permission
This operation makes an HTTP PUT request to the /rest/api/3/issuetypescheme/{issueTypeSchemeId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Type Scheme Id |
Number |
The ID of the issue type scheme. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Add Issue Types To Issue Type Scheme
<jira:update-rest-api3-issuetypescheme-issuetype-by-issue-type-scheme-id>
Adds issue types to an issue type scheme. The added issue types are appended to the issue types list. If any of the issue types exist in the issue type scheme, the operation fails and no issue types are added.
Permissions required:
Administer Jira global permission
This operation makes an HTTP PUT request to the /rest/api/3/issuetypescheme/{issueTypeSchemeId}/issuetype endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Type Scheme Id |
Number |
The ID of the issue type scheme. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Reorder Issue Types In Issue Type Scheme
<jira:update-rest-api3-issuetypescheme-issuetype-move-by-issue-type-scheme-id>
Changes the order of issue types in an issue type scheme. The request body parameters must meet the following requirements:
-
all of the issue types must belong to the issue type scheme.
-
either
afterorpositionmust be provided. -
the issue type in
aftermust not be in the issue type list.
Permissions required:
Administer Jira global permission
This operation makes an HTTP PUT request to the /rest/api/3/issuetypescheme/{issueTypeSchemeId}/issuetype/move endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Type Scheme Id |
Number |
The ID of the issue type scheme. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Assign Issue Type Scheme To Project
<jira:update-rest-api3-issuetypescheme-project>
Assigns an issue type scheme to a project. If any issues in the project are assigned issue types not present in the new scheme, the operation will fail. To complete the assignment those issues must be updated to use issue types in the new scheme. Issue type schemes can only be assigned to classic projects.
Permissions required:
Administer Jira global permission
This operation makes an HTTP PUT request to the /rest/api/3/issuetypescheme/project endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update Issue Type Screen Scheme
<jira:update-rest-api3-issuetypescreenscheme-by-issue-type-screen-scheme-id>
Updates an issue type screen scheme.
Permissions required:
Administer Jira global permission
This operation makes an HTTP PUT request to the /rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Type Screen Scheme Id |
String |
The ID of the issue type screen scheme. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Append Mappings For Issue Type Screen Scheme
<jira:update-rest-api3-issuetypescreenscheme-mapping-by-issue-type-screen-scheme-id>
Appends issue type to screen scheme mappings to an issue type screen scheme.
Permissions required:
Administer Jira global permission
This operation makes an HTTP PUT request to the /rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Type Screen Scheme Id |
String |
The ID of the issue type screen scheme. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update Default Screen Scheme
<jira:update-rest-api3-issuetypescreenscheme-mapping-default-by-issue-type-screen-scheme-id>
Updates the default screen scheme of an issue type screen scheme. The default screen scheme is used for all unmapped issue types.
Permissions required:
Administer Jira global permission
This operation makes an HTTP PUT request to the /rest/api/3/issuetypescreenscheme/{issueTypeScreenSchemeId}/mapping/default endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Issue Type Screen Scheme Id |
String |
The ID of the issue type screen scheme. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Assign Issue Type Screen Scheme To Project
<jira:update-rest-api3-issuetypescreenscheme-project>
Assigns an issue type screen scheme to a project. Issue type screen schemes can only be assigned to classic projects.
Permissions required:
Administer Jira global permission.
This operation makes an HTTP PUT request to the /rest/api/3/issuetypescreenscheme/project endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Set Preference
<jira:update-rest-api3-mypreferences>
Creates a preference for the user or updates a preference’s value by sending a plain text string. For example, false. An arbitrary preference can be created with the value containing up to 255 characters. In addition, the following keys define system preferences that can be set or created:
-
user.notifications.mimetype The MIME type used in notifications sent to the user. Defaults to
html. -
user.notify.own.changes Whether the user gets notified of their own changes. Defaults to
false. -
user.default.share.private Whether new [ filters](https://confluence.atlassian.com/x/eQiiLQ) are set to private. Defaults to
true. -
user.keyboard.shortcuts.disabled Whether keyboard shortcuts are disabled. Defaults to
false. -
user.autowatch.disabled Whether the user automatically watches issues they create or add a comment to. By default, not set: the user takes the instance autowatch setting. Note that these keys are deprecated:
-
jira.user.locale The locale of the user. By default, not set. The user takes the instance locale.
-
jira.user.timezone The time zone of the user. By default, not set. The user takes the instance timezone. Use Update a user profile from the user management REST API to manage timezone and locale instead.
Permissions required:
Permission to access Jira.
This operation makes an HTTP PUT request to the /rest/api/3/mypreferences endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
key |
String |
The key of the preference. The maximum length is 255 characters. |
x |
|
Body |
String |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update Permission Scheme
<jira:update-rest-api3-permissionscheme-by-scheme-id>
Updates a permission scheme. Below are some important things to note when using this resource:
-
If a permissions list is present in the request, then it is set in the permission scheme, overwriting all existing grants.
-
If you want to update only the name and description, then do not send a permissions list in the request.
-
Sending an empty list will remove all permission grants from the permission scheme. If you want to add or delete a permission grant instead of updating the whole list, see [Create permission grant](api-rest-api-3-permissionscheme-schemeId-permission-post) or [Delete permission scheme entity](api-rest-api-3-permissionscheme-schemeId-permission-permissionId-delete). See [About permission schemes and grants](about-permission-schemes) for more details.
Permissions required:
Administer Jira global permission
This operation makes an HTTP PUT request to the /rest/api/3/permissionscheme/{schemeId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Scheme Id |
Number |
The ID of the permission scheme to update. |
x |
|
expand |
String |
Use
|
||
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update Project Avatar
<jira:update-rest-api3-project-avatar-by-project-id-or-key>
Sets the avatar displayed for a project. Use [Load project avatar](#api-rest-api-3-project-projectIdOrKey-avatar2-post) to store avatars against the project, before using this operation to set the displayed avatar.
Permissions required:
Administer projects project permission.
This operation makes an HTTP PUT request to the /rest/api/3/project/{projectIdOrKey}/avatar endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Project Id Or Key |
String |
The ID or (case-sensitive) key of the project. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update Project
<jira:update-rest-api3-project-by-project-id-or-key>
Updates the [project details](https://confluence.atlassian.com/x/ahLpNw) of a project. All parameters are optional in the body of the request.
Permissions required:
Administer Jira global permission
This operation makes an HTTP PUT request to the /rest/api/3/project/{projectIdOrKey} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Project Id Or Key |
String |
The project ID or project key (case sensitive). |
x |
|
expand |
String |
Use
|
||
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update Project Category
<jira:update-rest-api3-project-category-by-id>
Updates a project category.
Permissions required:
Administer Jira global permission
This operation makes an HTTP PUT request to the /rest/api/3/projectCategory/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
id |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update Project Email
<jira:update-rest-api3-project-email-by-project-id>
Sets the [project’s sender email address](https://confluence.atlassian.com/x/dolKLg). If emailAddress is an empty string, the default email address is restored.
Permissions required:
Browse projects project permission for the project.
This operation makes an HTTP PUT request to the /rest/api/3/project/{projectId}/email endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Project Id |
Number |
The project ID. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Assign Permission Scheme
<jira:update-rest-api3-project-permissionscheme-by-project-key-or-id>
Assigns a permission scheme with a project. See Managing project permissions for more information about permission schemes.
Permissions required:
Administer Jira global permission
This operation makes an HTTP PUT request to the /rest/api/3/project/{projectKeyOrId}/permissionscheme endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Project Key Or Id |
String |
The project ID or project key (case sensitive). |
x |
|
expand |
String |
Use
|
||
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Set Project Property
<jira:update-rest-api3-project-properties-by-project-id-or-key-property-key>
Sets the value of the project property. You can use project properties to store custom data against the project. The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.
This operation can be accessed anonymously.
Permissions required:
Administer Jira global permission or Administer Projects project permission for the project in which the property is created.
This operation makes an HTTP PUT request to the /rest/api/3/project/{projectIdOrKey}/properties/{propertyKey} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Project Id Or Key |
String |
The project ID or project key (case sensitive). |
x |
|
Property Key |
String |
The key of the project property. The maximum length is 255 characters. |
x |
|
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Set Actors
<jira:update-rest-api3-project-role-by-project-id-or-key-id>
Sets the actors for a project role for a project, replacing all existing actors. To add actors to the project without overwriting the existing list, use [Add actors to project role](#api-rest-api-3-project-projectIdOrKey-role-id-post).
Permissions required:
Administer Projects project permission for the project or Administer Jira global permission.
This operation makes an HTTP PUT request to the /rest/api/3/project/{projectIdOrKey}/role/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Project Id Or Key |
String |
The project ID or project key (case sensitive). |
x |
|
id |
Number |
The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Fully Update Project Role
<jira:update-rest-api3-role-by-id>
Updates the project role’s name and description. You must include both a name and a description in the request.
Permissions required:
Administer Jira global permission
This operation makes an HTTP PUT request to the /rest/api/3/role/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the project role. Use [Get all project roles](#api-rest-api-3-role-get) to get a list of project role IDs. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update Screen
<jira:update-rest-api3-screens-by-screen-id>
Updates a screen. Only screens used in classic projects can be updated.
Permissions required:
Administer Jira global permission
This operation makes an HTTP PUT request to the /rest/api/3/screens/{screenId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Screen Id |
Number |
The ID of the screen. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Rename Screen Tab
<jira:update-rest-api3-screens-tabs-by-screen-id-tab-id>
Updates the name of a screen tab.
Permissions required:
Administer Jira global permission
This operation makes an HTTP PUT request to the /rest/api/3/screens/{screenId}/tabs/{tabId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Screen Id |
Number |
The ID of the screen. |
x |
|
Tab Id |
Number |
The ID of the screen tab. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update Screen Scheme
<jira:update-rest-api3-screenscheme-by-screen-scheme-id>
Updates a screen scheme. Only screen schemes used in classic projects can be updated.
Permissions required:
Administer Jira global permission
This operation makes an HTTP PUT request to the /rest/api/3/screenscheme/{screenSchemeId} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Screen Scheme Id |
String |
The ID of the screen scheme. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Set Issue Navigator Default Columns
<jira:update-rest-api3-settings-columns>
Sets the default issue navigator columns. The columns parameter accepts a navigable field value and is expressed as HTML form data. To specify multiple columns, pass multiple columns parameters. For example, in curl: curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/3/settings/columns If no column details are sent, then all default columns are removed. A navigable field is one that can be used as a column on the issue navigator. Find details of navigable issue columns using [Get fields](#api-rest-api-3-field-get).
Permissions required:
Administer Jira global permission
This operation makes an HTTP PUT request to the /rest/api/3/settings/columns endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Body |
Array of String |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Set User Columns
<jira:update-rest-api3-user-columns>
Sets the default issue table columns for the user. If an account ID is not passed, the calling user’s default columns are set. If no column details are sent, then all default columns are removed. The parameters for this resource are expressed as HTML form data. For example, in curl: curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/3/user/columns?accountId=5b10ac8d82e05b22cc7d4ef5'
Permissions required:
-
Administer Jira global permission, to set the columns on any user.
-
Permission to access Jira, to set the calling user’s columns.
This operation makes an HTTP PUT request to the /rest/api/3/user/columns endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Account Id |
String |
The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
||
Body |
Array of String |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Set User Property
<jira:update-rest-api3-user-properties-by-property-key>
Sets the value of a user’s property. Use this resource to store custom data against a user. Note: This operation does not access the user properties created and maintained in Jira.
Permissions required:
-
Administer Jira global permission, to set a property on any user.
-
Access to Jira, to set a property on the calling user’s record.
This operation makes an HTTP PUT request to the /rest/api/3/user/properties/{propertyKey} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Property Key |
String |
The key of the user’s property. The maximum length is 255 characters. |
x |
|
Account Id |
String |
The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
||
User Key |
String |
This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details. |
||
username |
String |
This parameter is no longer available and will be removed from the documentation soon. See the deprecation notice for details. |
||
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update Version
<jira:update-rest-api3-version-by-id>
Updates a project version. This operation can be accessed anonymously.
Permissions required:
Administer Jira global permission or Administer Projects project permission for the project that contains the version.
This operation makes an HTTP PUT request to the /rest/api/3/version/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
The ID of the version. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Merge Versions
<jira:update-rest-api3-version-mergeto-by-id-move-issues-to>
Merges two project versions. The merge is completed by deleting the version specified in id and replacing any occurrences of its ID in fixVersion with the version ID specified in moveIssuesTo. Consider using [ Delete and replace version](#api-rest-api-3-version-id-removeAndSwap-post) instead. This resource supports swapping version values in fixVersion, affectedVersion, and custom fields. This operation can be accessed anonymously.
Permissions required:
Administer Jira global permission or Administer Projects project permission for the project that contains the version.
This operation makes an HTTP PUT request to the /rest/api/3/version/{id}/mergeto/{moveIssuesTo} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
String |
The ID of the version to delete. |
x |
|
Move Issues To |
String |
The ID of the version to merge into. |
x |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Refresh Webhooks
<jira:update-rest-api3-webhook-refresh>
Webhooks registered through the REST API expire after 30 days. Call this resource periodically to keep them alive. Unrecognized webhook IDs (nonexistent or belonging to other apps) are ignored.
Permissions required:
Only Connect apps can use this operation.
This operation makes an HTTP PUT request to the /rest/api/3/webhook/refresh endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update Workflow Transition Rule Configurations
<jira:update-rest-api3-workflow-rule-config>
Updates configuration of workflow transition rules. The following rule types are supported:
Only rules created by the calling Connect app can be updated.
Permissions required:
Only Connect apps can use this operation.
This operation makes an HTTP PUT request to the /rest/api/3/workflow/rule/config endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update Workflow Transition Property
<jira:update-rest-api3-workflow-transitions-properties-by-transition-id>
Updates a workflow transition by changing the property value. Trying to update a property that does not exist results in a new property being added to the transition. Transition properties are used to change the behavior of a transition. For more information, see Transition properties and Workflow properties.
Permissions required:
Administer Jira global permission
This operation makes an HTTP PUT request to the /rest/api/3/workflow/transitions/{transitionId}/properties endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Transition Id |
Number |
The ID of the transition. To get the ID, view the workflow in text mode in the Jira admin settings. The ID is shown next to the transition. |
x |
|
key |
String |
The key of the property being updated, also known as the name of the property. Set this to the same value as the |
x |
|
Workflow Name |
String |
The name of the workflow that the transition belongs to. |
x |
|
Workflow Mode |
Enumeration, one of:
|
The workflow status. Set to |
||
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update Workflow Scheme
<jira:update-rest-api3-workflowscheme-by-id>
Updates a workflow scheme, including the name, default workflow, issue type to project mappings, and more. If the workflow scheme is active (that is, being used by at least one project), then a draft workflow scheme is created or updated instead, provided that updateDraftIfNeeded is set to true.
Permissions required:
Administer Jira global permission
This operation makes an HTTP PUT request to the /rest/api/3/workflowscheme/{id} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the workflow scheme. Find this ID by editing the desired workflow scheme in Jira. The ID is shown in the URL as |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update Default Workflow
<jira:update-rest-api3-workflowscheme-default-by-id>
Sets the default workflow for a workflow scheme. Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true in the request object and a draft workflow scheme is created or updated with the new default workflow. The draft workflow scheme can be published in Jira.
Permissions required:
Administer Jira global permission
This operation makes an HTTP PUT request to the /rest/api/3/workflowscheme/{id}/default endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the workflow scheme. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update Workflow Scheme Draft
<jira:update-rest-api3-workflowscheme-draft-by-id>
Updates a draft workflow scheme. If a draft workflow scheme does not exist for the active workflow scheme, then a draft is created. Note that an active workflow scheme can only have one draft workflow scheme.
Permissions required:
Administer Jira global permission
This operation makes an HTTP PUT request to the /rest/api/3/workflowscheme/{id}/draft endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the active workflow scheme that the draft was created from. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update Draft Default Workflow
<jira:update-rest-api3-workflowscheme-draft-default-by-id>
Sets the default workflow for a workflow scheme’s draft.
Permissions required:
Administer Jira global permission
This operation makes an HTTP PUT request to the /rest/api/3/workflowscheme/{id}/draft/default endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the workflow scheme that the draft belongs to. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Set Workflow Scheme Draft Issue Type
<jira:update-rest-api3-workflowscheme-draft-issuetype-by-id-issue-type>
Sets the workflow for an issue type in a workflow scheme’s draft.
Permissions required:
Administer Jira global permission.
This operation makes an HTTP PUT request to the /rest/api/3/workflowscheme/{id}/draft/issuetype/{issueType} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the workflow scheme that the draft belongs to. |
x |
|
Issue Type |
String |
The ID of the issue type. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update Draft Workflow Mapping
<jira:update-rest-api3-workflowscheme-draft-workflow-by-id>
Sets the issue types for a workflow in a workflow scheme’s draft. The workflow can also be set as the default workflow for the draft workflow scheme. Unmapped issues types are mapped to the default workflow.
Permissions required:
Administer Jira global permission
This operation makes an HTTP PUT request to the /rest/api/3/workflowscheme/{id}/draft/workflow endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the workflow scheme that the draft belongs to. |
x |
|
Workflow Name |
String |
The name of the workflow. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Set Workflow Scheme Issue Type
<jira:update-rest-api3-workflowscheme-issuetype-by-id-issue-type>
Sets the workflow for an issue type in a workflow scheme. Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true in the request body and a draft workflow scheme is created or updated with the new issue type-workflow mapping. The draft workflow scheme can be published in Jira.
Permissions required:
Administer Jira global permission
This operation makes an HTTP PUT request to the /rest/api/3/workflowscheme/{id}/issuetype/{issueType} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the workflow scheme. |
x |
|
Issue Type |
String |
The ID of the issue type. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Associate Scheme With Project
<jira:update-rest-api3-workflowscheme-project>
Assigns a workflow scheme to a project. This operation is performed only when there are no issues in the project. Workflow schemes can only be assigned to classic projects.
Permissions required:
Administer Jira global permission
This operation makes an HTTP PUT request to the /rest/api/3/workflowscheme/project endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Update Workflow Mapping
<jira:update-rest-api3-workflowscheme-workflow-by-id>
Sets the issue types for a workflow in a workflow scheme. The workflow can also be set as the default workflow for the workflow scheme. Unmapped issues types are mapped to the default workflow. Note that active workflow schemes cannot be edited. If the workflow scheme is active, set updateDraftIfNeeded to true in the request body and a draft workflow scheme is created or updated with the new workflow-issue types mappings. The draft workflow scheme can be published in Jira.
Permissions required:
Administer Jira global permission
This operation makes an HTTP PUT request to the /rest/api/3/workflowscheme/{id}/workflow endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
id |
Number |
The ID of the workflow scheme. |
x |
|
Workflow Name |
String |
The name of the workflow. |
x |
|
Body |
Any |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Addon Properties Resource put Addon Property put
<jira:update-rest-atlassian-connect1-addons-properties-by-addon-key-property-key>
Sets the value of an app’s property. Use this resource to store custom data for your app. The value of the request body must be a [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum length is 32768 characters.
Permissions required:
Only a Connect app whose key matches addonKey can make this request.
This operation makes an HTTP PUT request to the /rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey} endpoint.
Parameters
| Name | Type | Description | Default Value | Required |
|---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Addon Key |
String |
The key of the app, as defined in its descriptor. |
x |
|
Property Key |
String |
The key of the property. |
x |
|
Body |
Binary |
the content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
Name of the configuration to use to execute this component. |
||
Streaming Strategy |
|
Configures how Mule processes streams. Repeatable streams are the default behavior. |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
Time unit that qualifies the Response Timeout. |
||
Streaming Type |
Enumeration, one of:
|
Defines whether to send the request using streaming. Setting the value to |
||
Target Variable |
String |
Name of the variable that stores the operation’s output. |
||
Target Value |
String |
Expression that evaluates the operation’s output. The expression outcome is stored in the target variable. |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Types
Proxy
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Host |
String |
x |
||
Port |
Number |
x |
||
Username |
String |
|||
Password |
String |
|||
Non Proxy Hosts |
String |
Tls
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Enabled Protocols |
String |
A comma separated list of protocols enabled for this context. |
||
Enabled Cipher Suites |
String |
A comma separated list of cipher suites enabled for this context. |
||
Trust Store |
||||
Key Store |
||||
Revocation Check |
Trust Store
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Path |
String |
The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store. |
||
Password |
String |
The password used to protect the trust store. |
||
Type |
String |
The type of store used. |
||
Algorithm |
String |
The algorithm used by the trust store. |
||
Insecure |
Boolean |
If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk. |
Key Store
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Path |
String |
The location (which will be resolved relative to the current classpath and file system, if possible) of the key store. |
||
Type |
String |
The type of store used. |
||
Alias |
String |
When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default. |
||
Key Password |
String |
The password used to protect the private key. |
||
Password |
String |
The password used to protect the key store. |
||
Algorithm |
String |
The algorithm used by the key store. |
Standard Revocation Check
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Only End Entities |
Boolean |
Only verify the last element of the certificate chain. |
||
Prefer Crls |
Boolean |
Try CRL instead of OCSP first. |
||
No Fallback |
Boolean |
Do not use the secondary checking method (the one not selected before). |
||
Soft Fail |
Boolean |
Avoid verification failure when the revocation server can not be reached or is busy. |
Custom Ocsp Responder
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Url |
String |
The URL of the OCSP responder. |
||
Cert Alias |
String |
Alias of the signing certificate for the OCSP response (must be in the trust store), if present. |
Reconnection
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Fails Deployment |
Boolean |
When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment will fail if the test doesn’t pass after exhausting the associated reconnection strategy |
||
Reconnection Strategy |
The reconnection strategy to use |
Reconnect
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Frequency |
Number |
How often (in ms) to reconnect |
||
Blocking |
Boolean |
If false, the reconnection strategy will run in a separate, non-blocking thread |
||
Count |
Number |
How many reconnection attempts to make |
Reconnect Forever
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Frequency |
Number |
How often (in ms) to reconnect |
||
Blocking |
Boolean |
If false, the reconnection strategy will run in a separate, non-blocking thread |
Expiration Policy
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Max Idle Time |
Number |
A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration |
||
Time Unit |
Enumeration, one of:
|
A time unit that qualifies the maxIdleTime attribute |
Http Response Attributes
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Status Code |
Number |
x |
||
Headers |
Object |
x |
||
Reason Phrase |
String |
x |
Repeatable In Memory Stream
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Initial Buffer Size |
Number |
This is the amount of memory that will be allocated in order to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then it will be expanded by according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. |
||
Buffer Size Increment |
Number |
This is by how much will be buffer size by expanded if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full. |
||
Max Buffer Size |
Number |
This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit. |
||
Buffer Unit |
Enumeration, one of:
|
The unit in which all these attributes are expressed |
Repeatable File Store Stream
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
In Memory Size |
Number |
Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk. |
||
Buffer Unit |
Enumeration, one of:
|
The unit in which maxInMemorySize is expressed |
Repeatable In Memory Iterable
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
Initial Buffer Size |
Number |
This is the amount of instances that will be initially be allowed to be kept in memory in order to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then it will be expanded according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances. |
||
Buffer Size Increment |
Number |
This is by how much will the buffer size by expanded if it exceeds its initial size. Setting a value of zero or lower will mean that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised when the buffer gets full. Default value is 100 instances. |
||
Max Buffer Size |
Number |
This is the maximum amount of memory that will be used. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error will be raised. A value lower or equal to zero means no limit. |
Repeatable File Store Iterable
| Field | Type | Description | Default Value | Required |
|---|---|---|---|---|
In Memory Objects |
Number |
This is the maximum amount of instances that will be kept in memory. If more than that is required, then it will start to buffer the content on disk. |
||
Buffer Unit |
Enumeration, one of:
|
The unit in which maxInMemorySize is expressed |