Atlassian Jira Software

LAST UPDATED: NOVEMBER 3, 2025

Overview

Atlassian Jira Software is an issue and project tracking platform used to plan, track and manage agile and software development projects.

D3 SOAR is providing REST operations to function with Jira Software.

Jira is available for use in:

D3 SOAR	V12.7.83.0+
Category	Case Management
Deployment Options	Option II, Option IV

Known Limitations

The add-on allows a maximum of 500 API requests within a 5-minute period. If this limit is exceeded, HTTP status 429 is returned along with a message indicating that the limit has been reached.

Refer to REST API Rate Limits for detailed information.

Connection

To connect to Jira Software from D3 SOAR, follow this part to collect the required information below:

Parameter	Description	Example
Default
Server URL	The server URL of the Jira instance.	https://<site>.atlassian.net
Authentication Method	The authentication method (basic or OAuth) to use for the connection.	OAuth Authentication
API Version	The version of the API to use for the connection.	3
Basic Authentication
User Name	The user name to establish the API connection.	***@*.***
API Token	The API token to authenticate the API connection.	*****
OAuth Authentication
Client ID	The client ID to authenticate the API connection.	*****
Client Secret	The client secret to authenticate the API connection.	*****
Authorization Code	The authorization code for OAuth2.0 authentication. Click the "Get Authorization" button on the Connection page to automatically generate an authorization code.	*****
Callback URL	The callback URL for OAuth2.0 authentication. See step 10 of OAuth 2.0 Authentication for more information.	https://***.***
Refresh Token	The refresh token for the OAuth2.0 authentication with the grant type of authorization code. Click the "Get Refresh Token" button on the Connection page to automatically generate a refresh token. This parameter is read-only and Auto-generated.	*****

Permission Requirements

This integration requires the authenticated user to have the following classic scopes granted in the Jira developer console:

read:jira-work
read:jira-user
write:jira-work
manage:jira-configuration
manage:jira-data-provider
manage:jira-project

Configuring Atlassian Jira Software Software to Work with D3 SOAR

There are two available authentication methods: OAuth 2.0 Authentication and Basic Authentication. Refer to the appropriate section below for guidance.

OAuth 2.0 Authentication

Log into the Jira Developer Console.
Create an OAuth 2.0 integration app.
1. Click the Create button.
2. Select the OAuth 2.0 integration option.
3. Enter a name for the app.
4. Agree to the Atlassian developer terms.
5. Click the Create button.
Select the Permissions tab, then click the Add button to assign Jira API scopes.
Configure the Jira API scopes.
1. Click the Configure button.
2. Click the Edit Scopes button in the Jira platform REST API section.
3. Select the required classic scopes.
4. Click the Save button.
Add the callback URL from vSOC.
1. Select the Authorization tab.
2. Click the Add button.
3. Enter the Callback URL on the connection form.
  Refer to step 3.i.7 under Authentication Type: OAuth Authentication in Configuring D3 SOAR to Work with Atlassian Jira Software.
4. Click the Save changes button.
Select the Settings tab, then copy the Client ID and Secret.
Refer to step 3.i.4 and 3.i.5 under Authentication Type: OAuth Authentication in Configuring D3 SOAR to Work with Atlassian Jira Software.

Basic Authentication

The Basic Authentication method uses an API key for authentication and grants the same level of access as the associated user account has in the Jira web interface.

ALERT

Basic authentication—or using an API key for authentication—is less secure than OAuth 2.0 authentication. It is strongly recommended to use, or transition to, OAuth 2.0 authentication instead.
For more information on basic authentication, refer to Basic auth for REST APIs.

Navigate to the API Tokens creation page and log in when prompted.
Create an API token.
1. Click the Create API token button.
2. Enter a label.
3. (Optional) Edit the expiration date for the token.
4. Click the Create button.
Click Copy and save the API token in a secure location.
Refer to step 3.i.5 under Authentication Type: Basic Authentication in Configuring D3 SOAR to Work with Atlassian Jira Software.

ALERT

The API token is visible only at the time of creation.

Creating a User

See Invite a user from Atlassian Support for instructions.

Setting Up the Time Zone

Navigate to Profile and visibility and log in when prompted.
Select the Account preferences tab, then select the UTC time zone.

Configuring D3 SOAR to Work with Atlassian Jira Software

Log in to D3 SOAR.
Find the Jira integration.
1. Navigate to Configuration on the top header menu.
2. Click on the Integration icon on the left sidebar.
3. Type Atlassian Jira Software in the search box to find the integration, then click it to select it.
4. Click + Connection, on the right side of the Connections section. A new connection window will appear.
Configure the following fields to create a connection to Jira.
1. Connection Name: The desired name for the connection.
2. Site: The site on which to use the integration connection. Use the drop-down menu to select the site. The Share to Internal Sites option enables all internal sites to use the connection. Selecting a specific site will only enable that site to use the connection.
3. Recipient site for events from connections Shared to Internal Sites: This field is displayed when Share to Internal Sites is selected for the Site field, allowing selection of the internal site for deploying the integration connection.
4. Agent Name (Optional): The proxy agent required to build the connection. Use the dropdown menu to select the proxy agent from a list of previously configured proxy agents.
5. Description (Optional): The description for the connection.
6. Tenant (Optional): When configuring the connection from a master tenant site, users can choose the specific tenant sites with which to share the connection. Once this setting is enabled, users can filter and select the desired tenant sites from the dropdowns to share the connection.
7. Configure User Permissions: Defines which users have access to the connection.
8. Active: The checkbox that enables the connection to be used when selected.
9. System: This section contains the parameters defined specifically for the integration. These parameters must be configured to create the integration connection.
  1. Input the Jira server URL (e.g., https://company.atlassian.net).
  2. Select the Authentication Type.
  3. Input the API version to use for the connection. The default API version is 3.
  Authentication Type: Basic Authentication
  4. Enter the username of the Jira user to be used for the connection.
  5. Input the saved Jira API token. Refer to step 3 of Basic Authentication.
  Authentication Type: OAuth Authentication
  4.Input the saved Client ID. Refer to step 6 of OAuth 2.0 Authentication.
  5. Input the saved Client Secret. Refer to step 6 of OAuth 2.0 Authentication.
  6. Click Get Authorization to open Atlassian’s access request page. Click Accept. The authentication code will then appear and automatically fill this field.
  7. Copy the D3 Callback URL and paste it into Jira's Authorization page. Refer to 5d of OAuth 2.0 Authentication.
  8. Click the Get Refresh Token button.
10. Enable Password Vault: An optional feature that allows users to take the stored credentials from their own password vault. Refer to the password vault connection guide if needed.
11. Connection Health Check: Periodically checks the connection status by scheduling the Test Connection command at the specified interval (in minutes). Available only for active connections, this feature also allows configuring email notifications for failed attempts.
Test the connection.
1. Click on the Test Connection button to verify credentials and connectivity. A success alert displays Passed with a green checkmark. If the connection fails, review the parameters and retry.
2. Click OK to close the alert window.
3. Click + Add to create and add the configured connection.

READER NOTE

If the server URL is unknown, log into Atlassian Admin using administrator credentials to check all Atlassian products in the organization and their respective server URLs.
The Get Issue, List Transitions, and Transition Issue commands are incompatible with Jira API v3. Use a separate connection with API v2 instead.

Commands

Atlassian Jira Software includes the following executable commands for users to set up schedules or create playbook workflows. With the Test Command, users can execute these commands independently for playbook troubleshooting.

Integration API Note

For more information about the Atlassian Jira Software API, refer to the Atlassian Jira Software API reference.

READER NOTE

Certain permissions are required for each command. Refer to the Permission Requirements and Configuring Atlassian Jira Software to Work with D3 SOAR for details.

Note for Time-related parameters

The input format of time-related parameters may vary based on user account settings, which may cause the sample data in commands to differ from what is displayed. To adjust the time format, follow these steps:

Navigate to Configuration > Application Settings. Select Date/Time Format.
Choose the desired date and time format, then click on the Save button.

The selected time format will now be visible when configuring Date/Time command input parameters.

Add Comment To Issues

Adds a comment to issues in Jira.

READER NOTE

Issue IDs or Keys is a required parameter to run this command.
- Run the Search Issues command to obtain the Issue IDs or Keys.
  - Issue IDs can be found in the raw data at $.issues[*].id.
  - Issue Keys can be found in the raw data at $.issues[*].key.
The Visibility Type parameter can be used to restrict a comment's visibility. To use this function, follow the steps below:
- With an admin account, log in to Jira.
- Navigate to JIRA Settings > System > General Configuration.
- Ensure "Comment visibility" and is set to "Groups & Project Roles" and not "Project Roles only".
- To change the Comment visibility setting, click the Edit button at the top of the page.
- Scroll down the Options section, and find the Comment visibility setting. Select Groups and Project Roles.

Input

Input Parameter	Required/Optional	Description	Example
Issue IDs or Keys	Required	The IDs or keys of the issues to add a comment. Issue IDs and keys can be obtained using the Search Issues command.	JSON `[ "*****" ]`
Comment	Required	The comment text to add. You can input comments in plain text or HTML format. Please note, if you want to input HTML Markdown format, you can only use api version 2.	Conduct additional tests.
Visibility Type	Optional	The visibility type (i.e. group or role) to restrict the comment's visibility. The input value must correspond to the value defined in the Visibility Value parameter. Note: Comment visibility must be configured in Jira. Check under JIRA Settings > System > General Configuration for "Comment visibility" and ensure it is set to "Groups & Project Roles" and not "Project Roles only".	Role
Visibility Value	Optional	The name of the roles or groups to allow the comment's visibility. The input value must correspond to the value defined in the Visibility Type parameter. Note: Comment visibility must be configured in Jira. Check under JIRA Settings > System > General Configuration for "Comment visibility" and ensure it is set to "Groups & Project Roles" and not "Project Roles only".	Engineers

Output

To view the sample output data for all commands, refer to this article.

Error Handling

If the Return Data is Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Add Comment To Issues failed.
Status Code	The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Jira portal. Refer to the HTTP Status Code Registry for details.	Status Code: 400.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: You are currently not a member of the project role: Administrators.

Error Sample Data

Add Comment To Issues failed.

Status Code: 400.

Message: You are currently not a member of the project role: Administrators.

Add Web Link

Creates or updates a remote issue link for an issue.

READER NOTE

Issue ID or Key is a required parameter to run this command.

Run the Search Issues command to obtain the Issue IDs or Keys.
- Issue IDs can be found in the raw data at $.issues[*].id.
- Issue Keys can be found in the raw data at $.issues[*].key.

Input

Input Parameter	Required/Optional	Description	Example
Issue ID or Key	Required	The ID or key of the issue to add a remote issue link. Issue IDs and keys can be obtained using the Search Issues command.	JSON `[ "*****" ]`
URL	Required	The URL link to add or update.	https://***.***
Title	Required	The title of the link.	test Remote Link 0808a v3

Output

To view the sample output data for all commands, refer to this article.

Error Handling

If the Return Data is Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Add Web Link failed.
Status Code	The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Jira portal. Refer to the HTTP Status Code Registry for details.	Status Code: 401.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: Issue does not exist or you do not have permission to see it.

Error Sample Data

Add Web Link failed.

Status Code: 401.

Message: Unauthorized.

Assign Issue To User

Assigns issue(s) to a specified user. This command should be used when the calling user has the Assign issue permission but does not have the Edit Issues permission for the project that contains the designated issue(s).

READER NOTE

Issue IDs or Keys and Assignee are required parameters to run this command.

Run the Search Issues command to obtain the Issue IDs or Keys.
- Issue IDs can be found in the raw data at $.issues[*].id.
- Issue Keys can be found in the raw data at $.issues[*].key.
Run the List Users Assignable to Issue command to obtain the Assignee ID or Account Name. Assignee IDs or Account Names can be found in the raw data at:
- $.Results[*].accountId (account IDs)
- $.Results[*].displayName (account display names)
- $.Results[*].emailAddress (account email address)

The assignee must have access to the project containing the issue. If the error "User ____ cannot be assigned issues" appears, verify that the user has the necessary permissions for the project.

Input

Input Parameter	Required/Optional	Description	Example
Issue IDs or Keys	Required	The IDs or keys of the issues to assign. Issue IDs or Keys can be obtained using the Search Issues command.	JSON `[ "*****" ]`
Assignee ID or Account Name	Required	The account ID or account name (such as email or display name) of the user to whom the issue is assigned. Using the account ID is recommended to avoid ambiguity. Account ID or Account Name can be obtained using the List Users Assignable to Issue command.	5eca*****ea2d

Output

To view the sample output data for all commands, refer to this article.

Error Handling

If the Return Data is Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Assign Issue To User failed.
Status Code	The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Jira portal. Refer to the HTTP Status Code Registry for details.	Status Code: 404.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: Issue does not exist or you do not have permission to see it.

Error Sample Data

Assign Issue To User failed.

Status Code: 404.

Message: Issue does not exist or you do not have permission to see it.

Create Issue

Creates an issue or subtasks (if enabled) in Jira.

READER NOTE

Project Key and Issue Type Name are required parameters to run this command.

Run the Get Create Meta command to obtain the Project Key. Project Keys can be found in the returned raw data at the path $.projects[*].key.
Run the Get Create Meta command to obtain the Issue Type Names. Issue Type Names can be found in the returned raw data at the path $.projects[*].issuetypes[*].name.

Assignee ID or Account Name and Custom Fields are optional parameters to run this command.

Run the List Users Assignable to Issue command to obtain the Assignee ID or Account Name. Assignee IDs or Account Names can be found in the raw data at:
- $.Results[*].accountId (account IDs)
- $.Results[*].displayName (account display names)
- $.Results[*].emailAddress (account email address)
Run the List Fields command to obtain the Custom Fields.
- To add custom fields with an account ID, obtain the account ID using the Get Account IDs command. Account IDs can be found in the raw data at the path $.users[*].accountId.

Input

Input Parameter	Required/Optional	Description	Example
Project Key	Required	The key of the project to create the issue in. You can obtain the project key from returned raw data of the Get Create Meta command. Note: The project key is different from the project name.	*****
Issue Type Name	Required	The issue type to associate the issue. You can obtain all the available issue types for a specific project by running the Get Create Meta command. Note: Only configured issue types for the input project are valid for this parameter. Issue Type Names are case-sensitive.	Sub-task
Summary	Required	The summary text of the issue.	Issue's subtask1
Description	Optional	The description text of the issue. The description can be inputted in plain text or HTML format. Please note, if HTML Markdown format is to be used for input, only API version 2 can be used. For connection api version 3, Atlassian Document Format (ADF) JSON Object must be used for input.	subtask creation V3 description.0808d
Additional Information	Optional	The value of additional fields for the Epic and Sub-task issue types: Epic: The input additional information is the value of the Epic name. Sub-task: The input additional information is the value of the parent issue key.	New Epic
Assignee ID or Account Name	Optional	The account ID or account name (such as email or display name) of the user to whom the issue is assigned. Using the account ID is recommended to avoid ambiguity. Account ID or Account Name can be obtained using the List Users Assignable to Issue command.	***@*.***
Custom Fields	Optional	The JSON object containing the custom fields of the issue to update. The available custom fields can be obtained using the List Fields command. Note: The custom fields must be added to the issue's update screen. If you are adding custom fields with an account ID, you can obtain the account ID using the Get Account IDs command.	JSON `{ "customfield_10064": "Hello", "customfield_10003": [ { "accountId": "*****" } ] }`

Output

To view the sample output data for all commands, refer to this article.

Error Handling

If the Return Data is Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Create Issue failed.
Status Code	The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Jira portal. Refer to the HTTP Status Code Registry for details.	Status Code: 403.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: Specify a valid project ID or key.

Error Sample Data

Create Issue failed.

Status Code: 403.

Message: Specify a valid project ID or key.

Delete Issues

Deletes the specified issue(s).

READER NOTE

Issue IDs or Keys is a required parameter to run this command.

Run the Search Issues command to obtain the Issue IDs or Keys.
- Issue IDs can be found in the raw data at $.issues[*].id.
- Issue Keys can be found in the raw data at $.issues[*].key.

Input

Input Parameter	Required/Optional	Description	Example
Issue IDs or Keys	Required	The IDs or keys of the issues to retrieve details. Issue IDs and keys can be obtained using the Search Issues command.	JSON `[ "*****" ]`

Output

To view the sample output data for all commands, refer to this article.

Error Handling

If the Return Data is Partially Successful or Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Delete Issues failed.
Status Code	The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Jira portal. Refer to the HTTP Status Code Registry for details.	Status Code: 403.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: Issue does not exist or you do not have permission to see it.

Error Sample Data

Delete Issues failed.

Status Code: 403.

Message: Issue does not exist or you do not have permission to see it.

Download Attachment

Downloads all attachment files of the specified issue.

READER NOTE

Issue ID or Key is a required parameter to run this command.

Run the Search Issues command to obtain the Issue IDs or Keys.
- Issue IDs can be found in the raw data at $.issues[*].id.
- Issue Keys can be found in the raw data at $.issues[*].key.

If the command runs successfully with no returned results, there may be no attachments linked to the issue or the issue ID/key is invalid.

Input

Input Parameter	Required/Optional	Description	Example
Issue ID or Key	Required	The ID or key of the issue to download attachments. Issue IDs and keys can be obtained using the Search Issues command.	*****

Output

To view the sample output data for all commands, refer to this article.

Error Handling

If the Return Data is Partially Successful or Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Download Attachment failed.
Status Code	The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Jira portal. Refer to the HTTP Status Code Registry for details.	Status Code: 403.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: Invalid Token.

Error Sample Data

Download Attachment failed.

Status Code: 403.

Message: Invalid Token.

Edit Issue

Edits an issue in Jira.

READER NOTE

Issue Key or ID is a required parameter to run this command.

Run the Search Issues command to obtain the Issue Keys or IDs.
- Issue IDs can be found in the raw data at $.issues[*].id.
- Issue Keys can be found in the raw data at $.issues[*].key.

Assignee ID or Account Name and Custom Fields are optional parameters to run this command.

Run the List Users Assignable to Issue command to obtain the Assignee ID or Account Name. Assignee IDs or Account Names can be found in the raw data at:
- $.Results[*].accountId (account IDs)
- $.Results[*].displayName (account display names)
- $.Results[*].emailAddress (account email address)
Run the List Fields command to obtain the Custom Fields.
- To add custom fields with an account ID, obtain the account ID using the Get Account IDs command. Account IDs can be found in the raw data at the path $.users[*].accountId.

Input

Input Parameter	Required/Optional	Description	Example
Issue Key or ID	Required	The Key or ID of the issue to update. Issue keys and IDs can be obtained using the Search Issues command.	*****
Summary	Optional	The updated summary text of the issue.	Issue change 808b v3
Description	Optional	The updated description text of the issue. The description can be inputted in plain text or HTML format. Please note, HTML Markdown format is to be inputted, api version 2 must be used. For connection api version 3, if markdown format is to be inputted, Atlassian Document Format (ADF) JSON Object must be inputted.	description. 808b v3
Assignee ID or Account Name	Optional	Updates the issue assignee by account ID or account name (such as email or display name). Using the account ID is recommended to avoid ambiguity. Account ID or Account Name can be obtained using the List Users Assignable to Issue command.	***@*.***
Priority	Optional	The priority level of the issue. The built-in priorities are Highest, High, Medium, Low, Lowest. Note: If the priority field does not exist in the project, do not define this parameter.	Highest
Custom Fields	Optional	The JSON object containing the custom fields of the issue to update. The available custom fields can be obtained using the List Fields command. Note: The custom fields must be added to the issue's update screen. If you are adding custom fields with an account ID, you can obtain the account ID using the Get Account IDs command.	JSON `{ "customfield_10064": "Hello303b", "customfield_10003": [ { "accountId": "*****" } ] }`

Output

To view the sample output data for all commands, refer to this article.

Error Handling

If the Return Data is Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Edit Issue failed.
Status Code	The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Jira portal. Refer to the HTTP Status Code Registry for details.	Status Code: 404.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: Issue does not exist or you do not have permission to see it.

Error Sample Data

Edit Issue failed.

Status Code: 404.

Message: Issue does not exist or you do not have permission to see it.

Fetch Event

Returns issues based on the specified search conditions.

Input

Input Parameter	Required/Optional	Description	Example
Start Time	Optional	The start time of the time range to fetch issues in UTC time.	2022-08-01 00:00
End Time	Optional	The end time of the time range to fetch issues in UTC time.	2022-12-01 00:00
Query Time Type	Required	The time type to query results. The available time types are Issue Created Time, Updated Time, Resolved Time, Due Time and Last Viewed Time.	Created Time
Number of Event(s) Fetched	Optional	The maximum number of issues to return. If this parameter is not defined, all issues will be returned.	10
Search Condition	Optional	The JQL query string to return events. The commonly used syntax is <field> <operator> <value or function>. You may use the AND and OR operators between fields. See What is advanced searching in Jira Cloud? from Atlassian's documentation for more about JQL's syntax.	key= "*****"
Tolerance Scope (minute)	Optional	The tolerance scope (the default value is 10) in minutes of the query to fetch events between start and end time to avoid the loss of events. Events will be fetched between {Start Time - Tolerance Scope, End Time}.	10
Returned Fields	Optional	The list of fields to return for each issue should be used to retrieve a subset of fields. The possible values are "all", "navigable" and any issue field, prefixed with a minus to exclude. Note that if this field is specified but does not come with "all" or "navigable", the returned fields will only include specified fields.	JSON `[ "*all", "comment", "-updated" ]`

Output

To view the sample output data for all commands, refer to this article.

Fetch Event Field Mapping

See Field Mappings.

The Atlassian Jira Software system integration includes pre-configured field mappings for the default event source.

The Default Event Source is the default system-provided set of field mappings applied when the fetch event command is executed. It includes a Main Event JSON Path, which is the JSONPath expression that points to the base array of event objects. The source field path continues from this array to locate the required data.

The Main Event JSON Path can be viewed by clicking on the Edit Main JSON Path button.

Main Event JSON Path: $.issues
The issues array contains the event objects. Within each object, the key id denotes the Original event ID field. As such, the full JSONPath expression to extract the Original event ID is $.issues.id.

READER NOTE

The Unique Event Key field mapping is used to prevent duplicate event ingestions. D3 SOAR will check if the value of a selected JSON path matches any Unique Event Key of previously ingested events. If a match is found, the event will be dismissed. If no match is found, an event will be created. However, if no Unique Event Key is mapped, then the hash value from the event pending ingestion will be used to check for any matches with existing events. If no match is found, the event will be created.

Unlike most other D3 SOAR integrations, the Jira integration's Fetch Event command's Default Event Source mapping does not include Unique Event Key in order to fetch the same fetched issues with multiple updates.

The pre-configured field mappings are detailed below:

Field Name	Source Field
Original event ID	.id
Event name	.key
Event Type	.fields.issuetype.name
Description	.fields.issuetype.description
UTCEventTime	.fields.created
UpdateTime	.fields.updated
Status	.fields.status.name
Assignee	.fields.assignee.displayName

Error Handling

If the Return Data is Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Fetch Event failed.
Status Code	The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Jira portal. Refer to the HTTP Status Code Registry for details.	Status Code: 401.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: Error in the JQL Query: Expecting either \'OR\' or \'AND\' but got xxx.

Error Sample Data

Fetch Event failed.

Status Code: 401.

Message: Error in the JQL Query: Expecting either \'OR\' or \'AND\' but got xxx.

Get Account IDs

Returns account IDs of the specified users.

Input

Input Parameter	Required/Optional	Description	Example
User Display Names or Emails	Required	The display name or email addresses of the users to retrieve account IDs.	JSON `[ "***@*.***" ]`

Output

To view the sample output data for all commands, refer to this article.

Error Handling

If the Return Data is Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Get Account IDs failed.
Status Code	The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Jira portal. Refer to the HTTP Status Code Registry for details.	Status Code: 404.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: User Display Names or Emails Not Found.

Error Sample Data

Get Account IDs failed.

Status Code: 404.

Message: User Display Names or Emails Not Found.

Get Comment From Issues

Returns all comments for the specified issue(s).

READER NOTE

Issue IDs or Keys is a required parameter to run this command.

Run the Search Issues command to obtain the Issue IDs or Keys.
- Issue IDs can be found in the raw data at $.issues[*].id.
- Issue Keys can be found in the raw data at $.issues[*].key.

If the command runs successfully with no returned results, there may be no attachments linked to the issue or the issue ID/key is invalid.

Input

Input Parameter	Required/Optional	Description	Example
Issue IDs or Keys	Required	The IDs or keys of the issues to retrieve comments. Issue IDs and keys can be obtained using the Search Issues command.	JSON `[ "*****" ]`

Output

To view the sample output data for all commands, refer to this article.

Error Handling

If the Return Data is Partially Successful or Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Get Comment From Issues failed.
Status Code	The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Jira portal. Refer to the HTTP Status Code Registry for details.	Status Code: 404.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: Issue does not exist or you do not have permission to see it.

Error Sample Data

Get Comment From Issues failed.

Status Code: 404.

Message: Issue does not exist or you do not have permission to see it.

Get Create Meta

Returns details of projects, issue types within projects, and the create screen fields for each issue type for the user. Use this command to populate the input parameters of the Create Issue command.

Input

N/A

Output

To view the sample output data for all commands, refer to this article.

Error Handling

If the Return Data is Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Get Create Meta failed.
Status Code	The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Jira portal. Refer to the HTTP Status Code Registry for details.	Status Code: 403.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: Invalid Token.

Error Sample Data

Get Create Meta failed.

Status Code: 403.

Message: Invalid Token.

Get Issue

Retrieves details of the specified issue(s).

READER NOTE

This command is not compatible with Jira API v3. Use an API v2 connection to run this command.

Issue IDs or Keys is a required parameter to run this command.

Run the Search Issues command to obtain the Issue IDs or Keys.
- Issue IDs can be found in the raw data at $.issues[*].id.
- Issue Keys can be found in the raw data at $.issues[*].key.

Input

Input Parameter	Required/Optional	Description	Example
Issue IDs or Keys	Required	The IDs or keys of the issues to retrieve details. Issue IDs and keys can be obtained using the Search Issues command.	JSON `[ "*****" ]`
Fields	Optional	The list of fields to return for the issue. This parameter supports a comma-separated list. If this parameter is not defined, all fields will be returned.	summary,description,comment
Expand	Optional	Additional information about the issues to include in the response data. This parameter supports a comma-separated list. The available expand options include: renderfields names schema transitions editmeta changelog versionRepresentations (Note: When included in the request, the Fields parameter is ignored.) For more information about the expand parameter, see POST /rest/api/3/issue/bulk from Atlassian's documentation.	names,transitions

Output

To view the sample output data for all commands, refer to this article.

Error Handling

If the Return Data is Partially Successful or Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Get Issue failed.
Status Code	The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Jira portal. Refer to the HTTP Status Code Registry for details.	Status Code: 404.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: Issue does not exist or you do not have permission to see it.

Error Sample Data

Get Issue failed.

Status Code: 404.

Message: Issue does not exist or you do not have permission to see it.

Get Issue Links

Returns all issue links of the specified issue.

READER NOTE

Issue Key is a required parameter to run this command.

Run the Search Issues command to obtain the Issue Keys. Issue Keys can be found in the returned raw data at the path $.issues[*].key. Ensure you have selected the provided JSON path. Note: There are other keys with the name "key".

If the command runs successfully with no returned results, there may not be any existing links.

Input

Input Parameter	Required/Optional	Description	Example
Issue Key	Optional	The key of the issue is to return links. Issue keys can be obtained using the Search Issues command.	*****

Output

To view the sample output data for all commands, refer to this article.

Error Handling

If the Return Data is Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Get Issue Links failed.
Status Code	The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Jira portal. Refer to the HTTP Status Code Registry for details.	Status Code: 404.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: Issue does not exist or you do not have permission to see it.

Error Sample Data

Get Issue Links failed.

Status Code: 404.

Message: Issue does not exist or you do not have permission to see it.

List Transitions

Returns transition(s) that can be performed by the user on specific issues, dependent on the issues' statuses.

READER NOTE

This command is not compatible with Jira API v3. Use an API v2 connection to run this command.

Issue IDs or Keys is a required parameter to run this command.

Run the Search Issues command to obtain the Issue IDs or Keys.
- Issue IDs can be found in the raw data at $.issues[*].id.
- Issue Keys can be found in the raw data at $.issues[*].key.

Input

Input Parameter	Required/Optional	Description	Example
Issue IDs or Keys	Required	The IDs or keys of the issues to retrieve transitions. Issue IDs and keys can be obtained using the Search Issues command.	JSON `[ "*****" ]`

Output

To view the sample output data for all commands, refer to this article.

Error Handling

If the Return Data is Partially Successful or Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	List Transitions failed.
Status Code	The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Jira portal. Refer to the HTTP Status Code Registry for details.	Status Code: 404.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: Issue does not exist or you do not have permission to see it.

Error Sample Data

List Transitions failed.

Status Code: 404.

Message: Issue does not exist or you do not have permission to see it.

Link Issues

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.

READER NOTE

Issue linking must be enabled for this command. See Configure issue linking for details.
First Issue Key, Second Issue Key and Link Description are required parameters to run this command.
- Run the Search Issues command to obtain the Issue Keys. Issue Keys can be found in the raw data at $.issues[*].key.
- The available link descriptions can be found by navigating to Settings > Issue Features > Issue Linking in the Jira web app.

Input

Input Parameter	Required/Optional	Description	Example
First Issue Key	Required	The key of the first issue to link from. Issue keys can be obtained using the Search Issues command.	*****
Link Description	Required	The link relationship between the two issues (e.g. blocks, is blocked by). The available link descriptions (Inward or Outward) can be found by navigating to Settings > Issues > Issue Linking in the Jira web app. Note: This parameter is case-sensitive.	blocks
Second Issue Key	Required	The key of the second issue to link to. Issue keys can be obtained using the Search Issues command.	*****
Comment	Optional	The comments to be added for the link.	Local-* blocks Local-*

Output

To view the sample output data for all commands, refer to this article.

Error Handling

If the Return Data is Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Link Issues failed.
Status Code	The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Jira portal. Refer to the HTTP Status Code Registry for details.	Status Code: 404.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: Issue does not exist or you do not have permission to see it.

Error Sample Data

Link Issues failed.

Status Code: 404.

Message: Issue does not exist or you do not have permission to see it.

List Fields

Returns all system and custom issue fields.

Input

N/A

Output

To view the sample output data for all commands, refer to this article.

Error Handling

If the Return Data is Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	List Fields failed.
Status Code	The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Jira portal. Refer to the HTTP Status Code Registry for details.	Status Code: 401.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: Unauthorized User.

Error Sample Data

List Fields failed.

Status Code: 401.

Message: Unauthorized User.

List Projects

Returns a list of projects visible to the user, sorted by project key.

Input

N/A

Output

To view the sample output data for all commands, refer to this article.

Error Handling

If the Return Data is Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	List Projects failed.
Status Code	The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Jira portal. Refer to the HTTP Status Code Registry for details.	Status Code: 401.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: Unauthorized User.

Error Sample Data

List Projects failed.

Status Code: 401.

Message: Unauthorized User.

List Users Assignable to Issue

Returns all users who can be assigned to an issue. Exactly one parameter must be provided, either an issue-related parameter (Issue ID or Issue Key) or a project-related parameter (Project ID or Project Key). If both issue and project parameters are specified, the issue parameter is used. Due to Jira API limitations, only the first 1,000 users are checked, and the filter is applied to that group. The results may include up to 1,000 users, depending on how many match the filter.

READER NOTE

Issue ID and Issue Key are optional parameters to run this command.
- Run the Search Issues command to obtain the Issue ID and Issue Key.
  - Issue IDs can be found in the raw data at $.issues[*].id.
  - Issue Keys can be found in the raw data at $.issues[*].key.
Project ID and Project Key are optional parameters to run this command.
- Run the List Projects command to obtain the Project ID and Project Key.
  - Project IDs can be found in the raw data at $.values[*].id.
  - Project Keys can be found in the raw data at $.values[*].key.

Input

Input Parameter	Required/Optional	Description	Example
Issue ID	Optional	The unique numeric identifier of the issue. Use this parameter or Issue Key when checking assignable users for an existing issue. Issue ID can be obtained using the Search Issues command. If both Issue ID and Issue Key are provided, only the Issue ID will be used.	*****
Issue Key	Optional	The unique numeric identifier of the issue. Use this parameter or Issue ID when checking assignable users for an existing issue. Issue Key can be obtained using the Search Issues command. If both Issue ID and Issue Key are provided, only the Issue ID will be used.	LOCAL-2
Project ID	Optional	The unique numeric identifier of the project. Use this parameter or Project Key when checking assignable users for a new issue in the specified project. Project ID can be obtained using the List Projects command. If both Project ID and Project Key are provided, only the Project ID will be used.	*****
Project Key	Optional	The unique key identifier of the project. Use this parameter or Project ID when checking assignable users for a new issue in the specified project. Project Key can be obtained using the List Projects command. If both Project ID and Project Key are provided, only the Project ID will be used.	ENG

Output

To view the sample output data for all commands, refer to this article.

Error Handling

If the Return Data displays Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	List Users Assignable to Issue failed.
Status Code	The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Atlassian Jira Software portal. Refer to the HTTP Status Code Registry for details.	Status Code: 400.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: At least one of Issue ID, Issue Key, Project ID, Project Key must be provided.

Error Sample Data

List Users Assignable to Issue failed.

Status Code: 400.

Message: At least one of Issue ID, Issue Key, Project ID, Project Key must be provided.

Search Issues

Searches for issues in Jira using JQL. For more information about JQL search queries, see What is advanced searching in Jira Cloud?

Input

Input Parameter	Required/Optional	Description	Example
Filter	Optional	The JQL query string to return events. The commonly used syntax is <field> <operator> <value or function>. You may use the AND and OR operators between fields. See What is advanced searching in Jira Cloud? from Atlassian's documentation for more about JQL's syntax.	project=testProject and created > "2022-08-09" and assignee="*****"

Output

To view the sample output data for all commands, refer to this article.

Error Handling

If the Return Data is Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Search Issues failed.
Status Code	The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Jira portal. Refer to the HTTP Status Code Registry for details.	Status Code: 403.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: Error in the JQL Query.

Error Sample Data

Search Issues failed.

Status Code: 403.

Message: Error in the JQL Query.

Transition Issues

Performs a transition of the specified issue(s).

READER NOTE

This command is not compatible with Jira API v3. Use an API v2 connection to run this command.

Issue IDs or Keys and Transition Name are required parameters to run this command.

Run the Search Issues command to obtain the Issue IDs or Keys.
- Issue IDs can be found in the raw data at $.issues[*].id.
- Issue Keys can be found in the raw data at $.issues[*].key.
Run the List Transitions command to obtain the Transition Name. Transition Names can be found in the raw data at $.transitions[*].name.

Input

Input Parameter	Required/Optional	Description	Example
Issue IDs or Keys	Required	The ID or key of the issue to undertake transitions. Issue IDs and keys can be obtained using the Search Issues command.	JSON `[ "*****" ]`
Transition Name	Required	The name of the issue transition to apply (e.g. In Progress). Transition names can be obtained using the List Transitions command, or from the Jira console.	In Progress
Transition Fields	Optional	The JSON object containing the custom fields, sub-fields and the updated values for the issue.	JSON `{ "assignee": { "name": "bob" }, "resolution": { "name": "Fixed" } }`

Output

To view the sample output data for all commands, refer to this article.

Error Handling

If the Return Data is Partially Successful or Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Transition Issues failed.
Status Code	The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Jira portal. Refer to the HTTP Status Code Registry for details.	Status Code: 404.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: Issue does not exist or you do not have permission to see it.

Error Sample Data

Transition Issues failed.

Status Code: 404.

Message: Issue does not exist or you do not have permission to see it.

Unlink Issues

Deletes the specified issue link(s).

READER NOTE

Link IDs is a required parameter to run this command.

Run the Get Issue Links command to obtain the Link IDs. Link IDs can be found in the raw data at $.fields.issuelinks[*].id.

Input

Input Parameter	Required/Optional	Description	Example
Link IDs	Required	The ID(s) of the link(s) to delete. Link IDs can be obtained using the Get Issue Links command.	JSON `[ "*****" ]`

Output

To view the sample output data for all commands, refer to this article.

Error Handling

If the Return Data is Partially Successful or Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Unlink Issues failed.
Status Code	The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Jira portal. Refer to the HTTP Status Code Registry for details.	Status Code: 404.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: No issue link with id '10051' exists.

Error Sample Data

Unlink Issues failed.

Status Code: 404.

Message: No issue link with id '10051' exists.

Upload Files To Issue

Adds one or more attachments to a specified issue.

READER NOTE

Issue Key is a required parameter to run this command.

Run the Search Issues command to obtain the Issue Key. Issue Keys can be found in the raw data at $.issues[*].key.

File ID and File Source

It is not recommended to use the Test Command feature with the Upload File To Issue command as it is designed for dynamic input files in Playbooks, Incident Attachments, and Artifact Attachments. There is a simple workaround to test the command:

Navigate to Configuration on the top bar menu.
Click on Utility Commands on the left sidebar menu.
Use the search box to find and select the Create a File from input Text Array command.
Select the Test tab.
Input the required information for the parameters.
Click on the Test Command button. A D3 File ID will appear in the output data after the file has been successfully created. The D3 File Source of the created file will be Playbook File).

Input

Input Parameter	Required/Optional	Description	Example
Issue Key	Required	The key of the issue to upload attachments. Issue Key can be obtained using the Search Issues command.	*****
File IDs	Required	The file path of the file source.	JSON `[ "***", "***" ]`
File Source	Required	The source of the file to upload. The options for file sources are: Incident Attachment File: Manually uploaded file from Incident Playbook File: Output from another Task Artifact File: Ingested Artifact in an Event	Playbook File

Output

To view the sample output data for all commands, refer to this article.

Error Handling

If the Return Data is Partially Successful or Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Upload Files To Issue failed.
Status Code	The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Jira portal. Refer to the HTTP Status Code Registry for details.	Status Code: 404.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: Issue does not exist or you do not have permission to see it.

Error Sample Data

Upload Files To Issue failed.

Status Code: 404.

Message: Issue does not exist or you do not have permission to see it.

Test Connection

Allows users to perform a health check on an integration connection. Users can schedule a periodic health check by selecting Connection Health Check when editing an integration connection.

Input

N/A

Output

Output Type

Description

Return Data Type

Return Data

Indicates one of the possible command execution states: Successful or Failed.

The Failed state can be triggered by any of the following errors:

A connection issue with the integration
The API returned an error message
No response from the API

More details about an error can be viewed in the Error tab.

String

Error Handling

If the Return Data is Failed, an Error tab will appear in the Test Result window.

The error tab contains the details responded from D3 SOAR or third-party API calls, including Failure Indicator, Status Code, and Message. This can help locate the root cause of a command failure.

Parts in Error	Description	Example
Failure Indicator	Indicates the command failure that happened at a specific input and/or API call.	Test Connection failed.
Status Code	The response code issued by the third-party API server or the D3 SOAR system that can be used to locate the corresponding error category. For example, if the returned status code is 401, the selected connection is unauthorized to run the command. The user or system support would need to check the permission setting in the Jira portal. Refer to the HTTP Status Code Registry for details.	Status Code: 401.
Message	The raw data or captured key error message from the integration API server about the API request failure.	Message: Unauthorized User.

Error Sample Data

Test connection failed.

Status Code: 401.

Message: Unauthorized User.

FAQ

Why am I seeing the “Something went wrong” error when creating an OAuth connection in D3 SOAR?

You may not have enabled the necessary permission scopes for your Jira API app. See step 8 of OAuth 2.0 Authentication for instructions on enabling the required scopes.

Why does my connection no longer work?

The refresh token may expire after a certain period of time. Follow the setup instructions again starting from step 5 of Authentication Type: OAuth Authentication under Configuring D3 SOAR to Work with Atlassian Jira Software to request a new refresh token.