Skip to main content
Skip table of contents

Atlassian Jira Software

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

Your add-on can make 500 API requests per 5 minutes. Once you exceed the limit, calls will return HTTP status 429 and a message displaying that the limit has been reached.

Please refer to REST API Rate Limits for detailed information.

Connection

To connect to Jira Software from D3 SOAR, please 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.

test@d3security.com

API Token

The API token to authenticate the API connection.

Krw************************B82

OAuth Authentication

Client ID

The client ID to authenticate the API connection.

WCwz************************JWWv

Client Secret

The client secret to authenticate the API connection.

EiRQ********************************************aSv4

Authorization Code

The authorization code for OAuth2.0 authentication. Click the "Get Authorization" button on the Connection page to automatically generate an authorization code.

ucFDLlzx5*****************cHe8CPdIuM

Callback URL

The callback URL for OAuth2.0 authentication. See step 10 of OAuth 2.0 Authentication for more information.

https://d3pocsite/VSOC/Auth2Callback.aspx

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.

v1.M********************************Shp0

Permission Requirements

All commands will require the following classic scopes to run:

  • read:jira-work

  • read:jira-user

  • write:jira-work

  • manage:jira-configuration

  • manage:jira-data-provider

  • manage:jira-project

Configuring Jira Software to Work with D3 SOAR

Reader Note

There are two authentication methods to establish an integration connection with D3 SOAR: OAuth2.0 Authentication and Basic Authentication. Refer to the corresponding sections below depending on your use case.

OAuth 2.0 Authentication

  1. Log in to Jira (https://developer.atlassian.com/console/myapps/) with your credentials.

  2. Click on the profile icon on the top right corner, then select Developer Console.

  3. On the Developer Console page, click Create and select OAuth 2.0 integration.

  4. Enter an App Name, and agree to Atlassian developer terms. Click Create.

  5. Select Permissions from the left sidebar. Locate Jira API, and click its adjacent Add button.

  6. Click Configure.

  7. On the Jira API page, click Edit Scopes.

  8. Select the following required scopes, then click Save. For each commands' required permissions, see Permission Requirements.

  9. Select Authorization from the left sidebar. Locate OAuth 2.0 (3LO), and click its adjacent Add button.

  10. Enter the Callback URL generated from D3 SOAR (see step 4 of Authentication Type: OAuth Authentication under Configuring D3 SOAR to Work with Jira), then click Save changes.

  11. Select Settings from the left sidebar. Under the Authentication details section, copy the Client ID and Secret for use to build the integration connection in D3 SOAR.

Basic Authentication

Reader Note

The basic authentication method provides the same level of access as the user account would have access to on the Jira web UI.

  1. Log in to Jira (https://id.atlassian.com/manage-profile/security/api-tokens) with your credentials.

  2. Click Create API token.

  3. The Create an API token dialog box will appear. Enter a Label name and click Create.

  4. The generated API token will appear. Click Copy to save the API token to your clipboard. The API token will be required to build the integration connection in D3 SOAR.

Alert

You will only be able to view the API token once upon its creation. Store it in a secure location for future reference.

Creating a User

See Invite a user from Atlassian Support for instructions.

Setup Time Zone

  1. Login your Jira instance with the account that VSOC uses for authentication. Click your account icon on the top right corner, then click Manage account.

  2. Click Account preferences on the left side, then under Time zone click the current time zone; in the dropdown list, select UTC. This account which VSOC uses to connect to your JIRA instance will use UTC as its time zone.

Configuring D3 SOAR to Work with Jira

  1. Log in to D3 SOAR.

  2. 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 Jira 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.

  3. Configure the following fields to create a connection to Jira.

    1. Connection Name: The desired name for the connection.

    2. Site: Specifies the site to use the integration connection. Use the drop-down menu to select the site. The Share to Internal Sites option enables all sites defined as 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 appears if you selected Share to Internal Sites for Site to let you select the internal site to deploy the integration connection.

    4. Agent Name (Optional): Specifies 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): Add your desired description for the connection.

    6. Configure User Permissions: Defines which users have access to the connection.

    7. Active: Check the tick box to ensure the connection is available for use.

    8. System: This section contains the parameters defined specifically for the integration. These parameters must be configured to create the integration connection.
      Note: It is recommended to use the OAuth authentication method to build an integration connection with Jira. Atlassian is progressively disabling the basic authentication method. See Atlassian's deprecation notice for more information.
      Authentication Type: Basic Authentication

      1. Input the server URL of your Jira instance. Note: If you do not know your server URL, log in to Atlassian Admin (https://admin.atlassian.com/) with admin credentials. A list of all organizations will appear. Select the desired organization to see the associated Atlassian products with their respective server URLs.

      2. Select Basic Authentication.
      3. Input your Jira user name.
      4. Input your saved Jira API token (refer to step 4 of Basic Authentication).
      5. Input the API version to use for the connection. The default API version is 3.
      Note: The Get Issue, List Transitions, and Transition Issue commands are not currently compatible with the version 3 of Jira's API. If you need to use those commands, it is recommended to build a separate connection with API version 2.

      Authentication Type: OAuth Authentication

      1. Input the server URL of your Jira instance. Note: If you do not know your server URL, log in to Atlassian Admin (https://admin.atlassian.com/) with admin credentials. A list of all organizations will appear. Select the desired organization to see the associated Atlassian products with their respective server URLs.

      2. Input the saved Client ID (refer to step 11 of OAuth 2.0 Authentication).
      3. Input the saved Client Secret (refer to step 11 of OAuth 2.0 Authentication).
      4. Copy the D3 Callback URL, and paste it into Jira's Authentication page (refer to step 10 of OAuth 2.0 Authentication).
      5. Click Get Authorization. You will be directed to Atlassian's access request page. Select the server to allow access, then click Accept. An authentication code will appear, but no further action is required.

      6. Return to D3 SOAR. Click Get Refresh Token. The refresh token and authentication code will be automatically generated and entered into the corresponding parameters.
      7. Input the API version to use for the connection. The default API version is 3. Note: The Get Issue, List Transitions, and Transition Issue commands are not currently compatible with the version 3 of Jira's API. If you need to use those commands, it is recommended to build a separate connection with API version 2.

    9. Enable Password Vault: An optional feature that allows users to take the stored credentials from their own password vault. Please refer to the password vault connection guide if needed.

  4. Test the connection.

    1. Click Test Connection to verify the account credentials and network connection. If the Test Connection Passed alert window appears, the test connection is successful. You will see Passed with a green checkmark appear beside the Test Connection button. If the test connection fails, please check your connection parameters and try again.

    2. Click OK to close the alert window.

    3. Click + Add to create and add the configured connection.

Commands

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

Integration API Note

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

Reader Note

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

Note for Time-related parameters

The input format of time-related parameters may vary based on your account settings. As a result, the sample data provided in our commands is different from what you see. To set your preferred time format, follow these steps:

  1. Navigate to Configuration > Application Settings. Select Date/Time Format.

  2. Choose your desired date and time format.

After that, you will be able to view your preferred time format when configuring the DateTime input parameters for commands.

Add Comment To Issues

Adds a comment to issues in Jira.

Reader Note

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

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

  • 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.

[ "1***7" ]

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.

Comment test808a.

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

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON
[
    {
        "self": "https://team-15***18.atlassian.net/rest/api/3/issue/1***7/comment/1***4",
        "id": "1***4",
        "author": {
            "self": "https://team-15***18.atlassian.net/rest/api/3/user?accountId=5ec***2d",
            "accountId": "5ec***d",
            "emailAddress": "test@d3security.com",
            "avatarUrls": {
                "48x48": "https://secure.gravatar.com/avatar/d5a1***20?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png",
                "24x24": "https://secure.gravatar.com/avatar/d5a***20?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png",
                "16x16": "https://secure.gravatar.com/avatar/d5a1***320?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png",
                "32x32": "https://secure.gravatar.com/avatar/d5a1***20?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png"
            },
            "displayName": "D3 System Engineer Team",
            "active": true,
            "timeZone": "CET",
            "accountType": "atlassian"
        },
        "body": {
            "type": "doc",
            "version": 1,
            "content": [
                {
                    "type": "paragraph",
                    "content": [
                        {
                            "text": "Hello World 20220808a v3",
                            "type": "text"
                        }
                    ]
                }
            ]
        },
        "updateAuthor": {
            "self": "https://team-15***18.atlassian.net/rest/api/3/user?accountId=5e***a2d",
            "accountId": "5e***a2d",
            "emailAddress": "test@example.com",
            "avatarUrls": {
                "48x48": "https://secure.gravatar.com/avatar/d5a***20?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png",
                "24x24": "https://secure.gravatar.com/avatar/d5a***20?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png",
                "16x16": "https://secure.gravatar.com/avatar/d5a***20?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png",
                "32x32": "https://secure.gravatar.com/avatar/d5a***20?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png"
            },
            "displayName": "D3 System Engineer Team",
            "active": true,
            "timeZone": "CET",
            "accountType": "atlassian"
        },
        "created": "2022-08-08T19:22:23.179+0000",
        "updated": "2022-08-08T19:22:23.179+0000",
        "visibility": {
            "type": "group",
            "value": "powerful-users",
            "identifier": "790b***2c4"
        },
        "jsdPublic": true
    }
]
Context Data

The data extracted from Raw Data converted into JSON format. Context Data may be identical to Raw Data in some cases.

It is recommended to refer to the Raw Data instead of Context Data, since it contains the complete API response data. D3 will deprecate Context Data in the future, and playbook tasks using Context Data will be replaced with Raw Data.

SAMPLE DATA

CODE
No Sample Data
Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., will be extracted from Raw Data as Key Fields.
The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.

SAMPLE DATA

CODE
{
    "CommentLinks": [
        "https://team-15***8.atlassian.net/rest/api/3/issue/1***7/comment/1***4"
    ]
}
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

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE
Successful
Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

SELF

ID

AUTHOR

BODY

UPDATEAUTHOR

CREATED

UPDATED

VISIBILITY

JSDPUBLIC

https://team-1***118.atlassian.net/rest/api/3/issue/10017/comment/10014

1***4

{'self': 'https://team-15***8.atlassian.net/rest/api/3/user?accountId=5***2d', 'accountId': '5***ea2d', 'emailAddress': 'test@example.com', 'avatarUrls': {'48x48': 'https://secure.gravatar.com/avatar/d5***20?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png', '24x24': 'https://secure.gravatar.com/avatar/d5***20?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png', '16x16': 'https://secure.gravatar.com/avatar/d5***20?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png', '32x32': 'https://secure.gravatar.com/avatar/d5***20?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png'}, 'displayName': 'D3 System Engineer Team', 'active': True, 'timeZone': 'CET', 'accountType': 'atlassian'}

{'type': 'doc', 'version': 1, 'content': [{'type': 'paragraph', 'content': [{'text': 'Hello World 20220808a v3', 'type': 'text'}]}]}

{'self': 'https://team-15***18.atlassian.net/rest/api/3/user?accountId=5***2d', 'accountId': '5e***a2d', 'emailAddress': 'test@example.com', 'avatarUrls': {'48x48': 'https://secure.gravatar.com/avatar/d5***20?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png', '24x24': 'https://secure.gravatar.com/avatar/d5***20?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png', '16x16': 'https://secure.gravatar.com/avatar/d5***20?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png', '32x32': 'https://secure.gravatar.com/avatar/d5***20?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png'}, 'displayName': 'D3 System Engineer Team', 'active': True, 'timeZone': 'CET', 'accountType': 'atlassian'}

2022-08-08T19:22:23.179+0000

2022-08-08T19:22:23.179+0000

{'type': 'group', 'value': 'powerful-users', 'identifier': '79***2a-c***c4'}

True

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 you 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.

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 Issue ID or Key. Issue Key can be found in the returned raw data at the path $.issues[*].key. Ensure you have selected the provided JSON path. Issue IDs can be found in the returned raw data at the path $.issues[*].id. Note: There are other keys with the name "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.

[ "***" ]

URL

Required

The URL link to add or update.

https://xmr1.pool.minergate.com

Title

Required

The title of the link.

test Remote Link 0808a v3

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON
{
    "id": 1***2,
    "self": "https://api.atlassian.com/ex/jira/***-***-***-***-***/rest/api/3/issue/***/remotelink/1***2"
}
Context Data

The data extracted from Raw Data converted into JSON format. Context Data may be identical to Raw Data in some cases.

It is recommended to refer to the Raw Data instead of Context Data, since it contains the complete API response data. D3 will deprecate Context Data in the future, and playbook tasks using Context Data will be replaced with Raw Data.

SAMPLE DATA

CODE
No Sample Data
Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., will be extracted from Raw Data as Key Fields.
The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.

SAMPLE DATA

CODE
{
    "RemoteLink": "https://api.atlassian.com/ex/jira/***-***-***-***-***/rest/api/3/issue/***/remotelink/1***2"
}
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

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE
Successful
Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

id

1***2

self

https://api.atlassian.com/ex/jira/***-***-***-***-***/rest/api/3/issue/***/remotelink/1***2

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 you 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 Issue IDs or Keys. Issue Key can be found in the returned raw data at the path $.issues[*].key. Ensure you have selected the provided JSON path. Issue IDs can be found in the returned raw data at the path $.issues[*].id. Note: There are other keys with the name "key".

  • The Assignee can be retrieved from the User List. The user you choose must have access to the project that your input issue is linked to.

    • If you see the error message "User ____ cannot be assigned issues" when assigning an issue to a user, check that the user has appropriate access to the associated project.

Input

Input Parameter

Required/Optional

Description

Example

Issue IDs or Keys

Required

The IDs or keys of the issues to assign to the user. Issue IDs and keys can be obtained using the Search Issues command.

[ "***" ]

Assignee

Required

The email address or display name of the issue's assignee. Enter the assignee's full display name or email address to avoid ambiguity.

test@example.com

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON
{
    "AssignIssue": [
        {
            "IssueKey": "***",
            "Status": "Successful",
            "SelectedAccount": "62***d5",
            "MatchedAccounts": [
                "62***d5"
            ]
        }
    ]
}
Context Data

The data extracted from Raw Data converted into JSON format. Context Data may be identical to Raw Data in some cases.

D3 customizes the Context Data by extracting the data from path $.AssignIssue in API returned JSON.

It is recommended to refer to the Raw Data instead of Context Data, since it contains the complete API response data. D3 will deprecate Context Data in the future, and playbook tasks using Context Data will be replaced with Raw Data.

SAMPLE DATA

CODE
[
    {
        "IssueKey": "***",
        "Status": "Successful",
        "SelectedAccount": "62***d5",
        "MatchedAccounts": [
            "62***d5"
        ]
    }
]
Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., will be extracted from Raw Data as Key Fields.
The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.

SAMPLE DATA

CODE
{
    "IssueKeys": [
        "***"
    ]
}
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

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE
Successful
Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

ISSUEKEY

STATUS

SELECTEDACCOUNT

MATCHEDACCOUNTS


Successful

62***d5

['62***d5']

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 you 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 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 Issue Type Names. Issue Type Names can be found in the returned raw data at the path $.projects[*].issuetypes[*].name.

Input parameter Custom Fields is Optional to input to run this command.

  • Run the List Fields command to obtain Custom Fields.

  • If you are adding custom fields with an account ID, you can obtain the account ID using the Get Account IDs command. Account IDs can be found in the returned 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.

LOCAL

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

Optional

The email address or display name of the issue's assignee. Enter the assignee's full display name or email address to avoid ambiguity.

test@exaplme.com

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.

{

"customfield_1***4": "Hello",

"customfield_1***3": [

{ "accountId": "5e***d"

}

]

}

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON
{
    "id": "1***7",
    "key": "***",
    "self": "https://team-15***18.atlassian.net/rest/api/3/issue/1***7"
}
Context Data

The data extracted from Raw Data converted into JSON format. Context Data may be identical to Raw Data in some cases.

It is recommended to refer to the Raw Data instead of Context Data, since it contains the complete API response data. D3 will deprecate Context Data in the future, and playbook tasks using Context Data will be replaced with Raw Data.

SAMPLE DATA

CODE
No Sample Data
Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., will be extracted from Raw Data as Key Fields.
The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.

SAMPLE DATA

CODE
{
    "IssueId": 1***7,
    "IssueKey": "***"
}
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

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE
Successful
Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

id


key


self

https://team-15***18.atlassian.net/rest/api/3/issue/1***7

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 you 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

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

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

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.

[ "***" ]

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON
[
    {
        "IssueKey": "***",
        "result": "Issue: *** was deleted successfully."
    }
]
Context Data

The data extracted from Raw Data converted into JSON format. Context Data may be identical to Raw Data in some cases.

It is recommended to refer to the Raw Data instead of Context Data, since it contains the complete API response data. D3 will deprecate Context Data in the future, and playbook tasks using Context Data will be replaced with Raw Data.

SAMPLE DATA

CODE
No Sample Data
Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., will be extracted from Raw Data as Key Fields.
The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.

SAMPLE DATA

CODE
{
    "IssueKeys": [
        "***"
    ]
}
Return Data

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

The Partially Successful state only occurs when a command's input accepts an array of items (e.g. an array of issue keys) and one or more items within the array return an error from the API request.

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

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE
Successful
Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

ISSUEKEY

RESULT


Issue: *** was deleted successfully.

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 you 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 Issue ID or Key. Issue Key can be found in the returned raw data at the path $.issues[*].key. There are other keys with the name "key". Ensure you have selected the provided JSON path. Issue IDs can be found in the returned raw data at the path $.issues[*].id.

  • If the command runs successfully with no returned results, there may be no attachments in your input issues or invalid input issue IDs or Keys.

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

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON
[
    {
        "fileId": "***",
        "fileName": "lakeLouise.jpg",
        "md5": "035***5A",
        "sha1": "A8***E8B",
        "sha256": "BC***"
    }
]
Context Data

The data extracted from Raw Data converted into JSON format. Context Data may be identical to Raw Data in some cases.

It is recommended to refer to the Raw Data instead of Context Data, since it contains the complete API response data. D3 will deprecate Context Data in the future, and playbook tasks using Context Data will be replaced with Raw Data.

SAMPLE DATA

CODE
No Sample Data
Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., will be extracted from Raw Data as Key Fields.
The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.

SAMPLE DATA

CODE
{
    "FileIDs": [
        "***"
    ]
}
Return Data

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

The Partially Successful state only occurs when a command's input accepts an array of items (e.g. an array of issue keys) and one or more items within the array return an error from the API request.

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

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE
Successful
Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

FILEID

FILENAME

MD5

SHA1

SHA256


lakeLouise.jpg

035***5A

A8D***8B

BC***75C

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 you 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 ID or Key is a required parameter to run this command.

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

The Assignee can be retrieved from the User List. The user you choose must have access to the project that your input issue is linked to.

  • If you see the error message "User ____ cannot be assigned issues" when assigning an issue to a user, check that the user has appropriate access to the associated project.

Input parameter Custom Fields is Optional to input to run this command.

  • Run the List Fields command to obtain Custom Fields.

  • If custom fields are added with an account ID, the account ID can be obtained using the Get Account IDs command. Account IDs can be found in the returned raw data under 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.

epic test\n*BOLD*\n{color:#ff5630}red{color}

Assignee

Optional

The email address of display name of the issue's assignee. Enter the assignee's full display name or email address to avoid ambiguity.

test@example.com

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.

{

"customfield_1***4": "Hello303b",

"customfield_1***3": [

{

"accountId": "5***d"

}

]

}

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON
{
    "expand": "renderedFields,names,schema,operations,editmeta,changelog,versionedRepresentations,customfield_10010.requestTypePractice",
    "id": "1***5",
    "self": "https://api.atlassian.com/ex/jira/***-***-***-***-***/rest/api/3/issue/***",
    "key": "***",
    "fields": {
        "statuscategorychangedate": "2023-03-03T17:48:32.709+0000",
        "fixVersions": [],
        "resolution": null,
        "lastViewed": "2023-03-03T22:26:24.381+0000",
        "customfield_10062": null,
        "customfield_10063": null,
        "customfield_10064": "Hello303b",
        "priority": {
            "self": "https://api.atlassian.com/ex/jira/***-***-***-***-***/rest/api/3/priority/3",
            "iconUrl": "https://team-***.atlassian.net/images/icons/priorities/medium.svg",
            "name": "Medium",
            "id": "3"
        },
        "labels": [],
        "aggregatetimeoriginalestimate": null,
        "timeestimate": null,
        "versions": [],
        "issuelinks": [],
        "assignee": {
            "self": "https://api.atlassian.com/ex/jira/***-***-***-***-***/rest/api/3/user?accountId=***",
            "accountId": "***",
            "avatarUrls": {
                "48x48": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FS-3.png",
                "24x24": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FS-3.png",
                "16x16": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FS-3.png",
                "32x32": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FS-3.png"
            },
            "displayName": "***",
            "active": true,
            "timeZone": "Etc/GMT",
            "accountType": "app"
        },
        "status": {
            "self": "https://api.atlassian.com/ex/jira/***-***-***-***-***/rest/api/3/status/***",
            "description": "",
            "iconUrl": "https://api.atlassian.com/ex/jira/***-**8-***-***-***/",
            "name": "Backlog",
            "id": "***",
            "statusCategory": {
                "self": "https://api.atlassian.com/ex/jira/***-***-***-***-***/rest/api/3/statuscategory/2",
                "id": 2,
                "key": "new",
                "colorName": "blue-gray",
                "name": "To Do"
            }
        },
        "components": [],
        "customfield_10050": null,
        "customfield_10051": null,
        "customfield_10052": null,
        "customfield_10053": null,
        "customfield_10054": null,
        "customfield_10055": null,
        "customfield_10056": null,
        "customfield_10057": [],
        "customfield_10058": null,
        "customfield_10049": null,
        "aggregatetimeestimate": null,
        "creator": {
            "self": "https://api.atlassian.com/ex/jira/***/rest/api/3/user?accountId=***",
            "accountId": "***",
            "emailAddress": "test@example.com",
            "avatarUrls": {
                "48x48": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png",
                "24x24": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png",
                "16x16": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png",
                "32x32": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png"
            },
            "displayName": "D3 System Engineer Team",
            "active": true,
            "timeZone": "UTC",
            "accountType": "atlassian"
        },
        "subtasks": [],
        "customfield_10040": null,
        "customfield_10041": null,
        "customfield_10042": null,
        "customfield_10043": null,
        "reporter": {
            "self": "https://api.atlassian.com/ex/jira/***/rest/api/3/user?accountId=***",
            "accountId": "***",
            "emailAddress": "test@example.com",
            "avatarUrls": {
                "48x48": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png",
                "24x24": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png",
                "16x16": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png",
                "32x32": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png"
            },
            "displayName": "D3 System Engineer Team",
            "active": true,
            "timeZone": "UTC",
            "accountType": "atlassian"
        },
        "customfield_10044": null,
        "aggregateprogress": {
            "progress": 0,
            "total": 0
        },
        "customfield_10045": null,
        "customfield_10046": null,
        "customfield_10047": null,
        "customfield_10048": null,
        "customfield_10038": null,
        "customfield_10039": null,
        "progress": {
            "progress": 0,
            "total": 0
        },
        "votes": {
            "self": "https://api.atlassian.com/ex/jira/***/rest/api/3/issue/***/votes",
            "votes": 0,
            "hasVoted": false
        },
        "worklog": {
            "startAt": 0,
            "maxResults": 20,
            "total": 0,
            "worklogs": []
        },
        "issuetype": {
            "self": "https://api.atlassian.com/ex/jira/***/rest/api/3/issuetype/***",
            "id": "***",
            "description": "A problem or error.",
            "iconUrl": "https://api.atlassian.com/ex/jira/***/rest/api/2/universal_avatar/view/type/issuetype/avatar/***?size=medium",
            "name": "Bug",
            "subtask": false,
            "avatarId": ***,
            "hierarchyLevel": 0
        },
        "timespent": null,
        "customfield_10030": null,
        "project": {
            "self": "https://api.atlassian.com/ex/jira/***/rest/api/3/project/***",
            "id": "***",
            "key": "LOCAL",
            "name": "testProject",
            "projectTypeKey": "software",
            "simplified": false,
            "avatarUrls": {
                "48x48": "https://api.atlassian.com/ex/jira/***/rest/api/3/universal_avatar/view/type/project/avatar/***",
                "24x24": "https://api.atlassian.com/ex/jira/2***a/rest/api/3/universal_avatar/view/type/project/avatar/***?size=small",
                "16x16": "https://api.atlassian.com/ex/jira/2***a/rest/api/3/universal_avatar/view/type/project/avatar/***?size=xsmall",
                "32x32": "https://api.atlassian.com/ex/jira/2***a/rest/api/3/universal_avatar/view/type/project/avatar/***?size=medium"
            }
        },
        "customfield_10031": null,
        "customfield_10032": [],
        "customfield_10033": null,
        "aggregatetimespent": null,
        "customfield_10034": null,
        "customfield_10035": null,
        "customfield_10036": null,
        "customfield_10037": null,
        "customfield_10027": null,
        "customfield_10028": null,
        "customfield_10029": null,
        "resolutiondate": null,
        "workratio": -1,
        "issuerestriction": {
            "issuerestrictions": {},
            "shouldDisplay": false
        },
        "watches": {
            "self": "https://api.atlassian.com/ex/jira/***/rest/api/3/issue/***/watchers",
            "watchCount": 1,
            "isWatching": true
        },
        "created": "2023-03-03T17:48:32.261+0000",
        "customfield_10020": null,
        "customfield_10021": null,
        "customfield_10022": null,
        "customfield_10023": null,
        "customfield_10024": null,
        "customfield_10025": null,
        "customfield_10026": null,
        "customfield_10016": null,
        "customfield_10017": null,
        "customfield_10018": {
            "hasEpicLinkFieldDependency": false,
            "showField": false,
            "nonEditableReason": {
                "reason": "PLUGIN_LICENSE_ERROR",
                "message": "The Parent Link is only available to Jira Premium users."
            }
        },
        "customfield_10019": "0|i000tr:",
        "updated": "2023-03-03T22:26:06.453+0000",
        "timeoriginalestimate": null,
        "description": {
            "type": "doc",
            "version": 1,
            "content": [
                {
                    "type": "paragraph",
                    "content": [
                        {
                            "type": "text",
                            "text": "302description303"
                        }
                    ]
                }
            ]
        },
        "customfield_10010": null,
        "customfield_10014": null,
        "timetracking": {},
        "customfield_10015": null,
        "customfield_10005": null,
        "customfield_10006": null,
        "customfield_10007": null,
        "security": null,
        "customfield_10008": null,
        "attachment": [],
        "customfield_10009": null,
        "summary": "Issue change 303a",
        "customfield_10001": null,
        "customfield_10002": null,
        "customfield_10003": [
            {
                "self": "https://api.atlassian.com/ex/jira/***/rest/api/3/user?accountId=***",
                "accountId": "***",
                "emailAddress": "test@example.com",
                "avatarUrls": {
                    "48x48": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png",
                    "24x24": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png",
                    "16x16": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png",
                    "32x32": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png"
                },
                "displayName": "D3 System Engineer Team",
                "active": true,
                "timeZone": "UTC",
                "accountType": "atlassian"
            }
        ],
        "customfield_10004": null,
        "environment": null,
        "duedate": null,
        "comment": {
            "comments": [],
            "self": "https://api.atlassian.com/ex/jira/***/rest/api/3/issue/***/comment",
            "maxResults": 0,
            "total": 0,
            "startAt": 0
        }
    }
}
Context Data

The data extracted from Raw Data converted into JSON format. Context Data may be identical to Raw Data in some cases.

It is recommended to refer to the Raw Data instead of Context Data, since it contains the complete API response data. D3 will deprecate Context Data in the future, and playbook tasks using Context Data will be replaced with Raw Data.

SAMPLE DATA

CODE
No Sample Data
Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., will be extracted from Raw Data as Key Fields.
The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.

SAMPLE DATA

CODE
{
    "ID": [
        "***"
    ],
    "IssueKey": "***"
}
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

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE
Successful
Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

expand

renderedFields,names,schema,operations,editmeta,changelog,versionedRepresentations,customfield_10010.requestTypePractice

id


self

https://api.atlassian.com/ex/jira/***/rest/api/3/issue/***

key


fields

{'statuscategorychangedate': '2023-03-03T17:48:32.709+0000', 'fixVersions': [], 'resolution': None, 'lastViewed': '2023-03-03T22:26:24.381+0000', 'customfield_10062': None, 'customfield_10063': None, 'customfield_10064': 'Hello303b', 'priority': {'self': 'https://api.atlassian.com/ex/jira/***/rest/api/3/priority/3', 'iconUrl': 'https://team-***.atlassian.net/images/icons/priorities/medium.svg', 'name': 'Medium', 'id': '3'}, 'labels': [], 'aggregatetimeoriginalestimate': None, 'timeestimate': None, 'versions': [], 'issuelinks': [], 'assignee': {'self': 'https://api.atlassian.com/ex/jira/***/rest/api/3/user?accountId=***', 'accountId': '***', 'avatarUrls': {'48x48': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FS-3.png', '24x24': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FS-3.png', '16x16': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FS-3.png', '32x32': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FS-3.png'}, 'displayName': '***', 'active': True, 'timeZone': 'Etc/GMT', 'accountType': 'app'}, 'status': {'self': 'https://api.atlassian.com/ex/jira/***/rest/api/3/status/***', 'description': '', 'iconUrl': 'https://api.atlassian.com/ex/jira/***/', 'name': 'Backlog', 'id': '***', 'statusCategory': {'self': 'https://api.atlassian.com/ex/jira/***/rest/api/3/statuscategory/2', 'id': 2, 'key': 'new', 'colorName': 'blue-gray', 'name': 'To Do'}}, 'components': [], 'customfield_10050': None, 'customfield_10051': None, 'customfield_10052': None, 'customfield_10053': None, 'customfield_10054': None, 'customfield_10055': None, 'customfield_10056': None, 'customfield_10057': [], 'customfield_10058': None, 'customfield_10049': None, 'aggregatetimeestimate': None, 'creator': {'self': 'https://api.atlassian.com/ex/jira/***/rest/api/3/user?accountId=***', 'accountId': '***', 'emailAddress': 'test@example.com', 'avatarUrls': {'48x48': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png', '24x24': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png', '16x16': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png', '32x32': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png'}, 'displayName': 'D3 System Engineer Team', 'active': True, 'timeZone': 'UTC', 'accountType': 'atlassian'}, 'subtasks': [], 'customfield_10040': None, 'customfield_10041': None, 'customfield_10042': None, 'customfield_10043': None, 'reporter': {'self': 'https://api.atlassian.com/ex/jira/***/rest/api/3/user?accountId=***', 'accountId': '***', 'emailAddress': 'test@example.com', 'avatarUrls': {'48x48': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png', '24x24': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png', '16x16': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png', '32x32': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png'}, 'displayName': 'D3 System Engineer Team', 'active': True, 'timeZone': 'UTC', 'accountType': 'atlassian'}, 'customfield_10044': None, 'aggregateprogress': {'progress': 0, 'total': 0}, 'customfield_10045': None, 'customfield_10046': None, 'customfield_10047': None, 'customfield_10048': None, 'customfield_10038': None, 'customfield_10039': None, 'progress': {'progress': 0, 'total': 0}, 'votes': {'self': 'https://api.atlassian.com/ex/jira/***/rest/api/3/issue/***/votes', 'votes': 0, 'hasVoted': False}, 'worklog': {'startAt': 0, 'maxResults': 20, 'total': 0, 'worklogs': []}, 'issuetype': {'self': 'https://api.atlassian.com/ex/jira/***/rest/api/3/issuetype/***', 'id': '***', 'description': 'A problem or error.', 'iconUrl': 'https://api.atlassian.com/ex/jira/***/rest/api/2/universal_avatar/view/type/issuetype/avatar/***?size=medium', 'name': 'Bug', 'subtask': False, 'avatarId': ***, 'hierarchyLevel': 0}, 'timespent': None, 'customfield_10030': None, 'project': {'self': 'https://api.atlassian.com/ex/jira/***/rest/api/3/project/***', 'id': '***', 'key': 'LOCAL', 'name': 'testProject', 'projectTypeKey': 'software', 'simplified': False, 'avatarUrls': {'48x48': 'https://api.atlassian.com/ex/jira/***/rest/api/3/universal_avatar/view/type/project/avatar/***', '24x24': 'https://api.atlassian.com/ex/jira/***/rest/api/3/universal_avatar/view/type/project/avatar/***?size=small', '16x16': 'https://api.atlassian.com/ex/jira/***/rest/api/3/universal_avatar/view/type/project/avatar/***?size=xsmall', '32x32': 'https://api.atlassian.com/ex/jira/***/rest/api/3/universal_avatar/view/type/project/avatar/***?size=medium'}}, 'customfield_10031': None, 'customfield_10032': [], 'customfield_10033': None, 'aggregatetimespent': None, 'customfield_10034': None, 'customfield_10035': None, 'customfield_10036': None, 'customfield_10037': None, 'customfield_10027': None, 'customfield_10028': None, 'customfield_10029': None, 'resolutiondate': None, 'workratio': -1, 'issuerestriction': {'issuerestrictions': {}, 'shouldDisplay': False}, 'watches': {'self': 'https://api.atlassian.com/ex/jira/***/rest/api/3/issue/***/watchers', 'watchCount': 1, 'isWatching': True}, 'created': '2023-03-03T17:48:32.261+0000', 'customfield_10020': None, 'customfield_10021': None, 'customfield_10022': None, 'customfield_10023': None, 'customfield_10024': None, 'customfield_10025': None, 'customfield_10026': None, 'customfield_10016': None, 'customfield_10017': None, 'customfield_10018': {'hasEpicLinkFieldDependency': False, 'showField': False, 'nonEditableReason': {'reason': 'PLUGIN_LICENSE_ERROR', 'message': 'The Parent Link is only available to Jira Premium users.'}}, 'customfield_10019': '0|i000tr:', 'updated': '2023-03-03T22:26:06.453+0000', 'timeoriginalestimate': None, 'description': {'type': 'doc', 'version': 1, 'content': [{'type': 'paragraph', 'content': [{'type': 'text', 'text': '302description303'}]}]}, 'customfield_10010': None, 'customfield_10014': None, 'timetracking': {}, 'customfield_10015': None, 'customfield_10005': None, 'customfield_10006': None, 'customfield_10007': None, 'security': None, 'customfield_10008': None, 'attachment': [], 'customfield_10009': None, 'summary': 'Issue change 303a', 'customfield_10001': None, 'customfield_10002': None, 'customfield_10003': [{'self': 'https://api.atlassian.com/ex/jira/***/rest/api/3/user?accountId=***', 'accountId': '***', 'emailAddress': 'test@example.com', 'avatarUrls': {'48x48': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png', '24x24': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png', '16x16': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png', '32x32': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png'}, 'displayName': 'D3 System Engineer Team', 'active': True, 'timeZone': 'UTC', 'accountType': 'atlassian'}], 'customfield_10004': None, 'environment': None, 'duedate': None, 'comment': {'comments': [], 'self': 'https://api.atlassian.com/ex/jira/***/rest/api/3/issue/***/comment', 'maxResults': 0, 'total': 0, 'startAt': 0}}

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 you 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.

[ "*all", "comment" , "-updated"]

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON
{
    "expand": "schema,names",
    "startAt": 0,
    "maxResults": 50,
    "total": 2,
    "issues": [
        {
            "expand": "operations,versionedRepresentations,editmeta,changelog,renderedFields",
            "id": "***",
            "self": "https://d3securitycyber.atlassian.net/rest/api/2/issue/***",
            "key": "***",
            "fields": {
                "statuscategorychangedate": "2021-05-27T14:05:03.256-07:00",
                "issuetype": {
                    "self": "https://d3securitycyber.atlassian.net/rest/api/2/issuetype/***",
                    "id": "***",
                    "description": "A problem or error.",
                    "iconUrl": "https://d3securitycyber.atlassian.net/secure/viewavatar?size=medium&avatarId=***&avatarType=issuetype",
                    "name": "Bug",
                    "subtask": false,
                    "avatarId": ***,
                    "hierarchyLevel": 0
                },
                "timespent": null,
                "customfield_10030": null,
                "project": {
                    "self": "https://d3securitycyber.atlassian.net/rest/api/2/project/***",
                    "id": "***",
                    "key": "***",
                    "name": "d3security",
                    "projectTypeKey": "software",
                    "simplified": false,
                    "avatarUrls": {
                        "48x48": "https://d3securitycyber.atlassian.net/secure/projectavatar?pid=***&avatarId=***",
                        "24x24": "https://d3securitycyber.atlassian.net/secure/projectavatar?size=small&s=small&pid=***&avatarId=***",
                        "16x16": "https://d3securitycyber.atlassian.net/secure/projectavatar?size=xsmall&s=xsmall&pid=***&avatarId=***",
                        "32x32": "https://d3securitycyber.atlassian.net/secure/projectavatar?size=medium&s=medium&pid=***&avatarId=***"
                    }
                },
                "customfield_10031": null,
                "customfield_10032": null,
                "fixVersions": [],
                "aggregatetimespent": null,
                "customfield_10034": null,
                "resolution": null,
                "customfield_10035": null,
                "customfield_10027": null,
                "resolutiondate": null,
                "workratio": -1,
                "lastViewed": null,
                "watches": {
                    "self": "https://d3securitycyber.atlassian.net/rest/api/2/issue/***/watchers",
                    "watchCount": 1,
                    "isWatching": true
                },
                "created": "2021-05-27T14:05:02.705-07:00",
                "customfield_10020": null,
                "customfield_10021": null,
                "customfield_10022": null,
                "priority": {
                    "self": "https://d3securitycyber.atlassian.net/rest/api/2/priority/3",
                    "iconUrl": "https://d3securitycyber.atlassian.net/images/icons/priorities/medium.svg",
                    "name": "Medium",
                    "id": "3"
                },
                "customfield_10023": null,
                "customfield_10024": null,
                "customfield_10025": [],
                "labels": [],
                "customfield_10026": null,
                "customfield_10016": null,
                "customfield_10017": null,
                "customfield_10018": {
                    "hasEpicLinkFieldDependency": false,
                    "showField": false,
                    "nonEditableReason": {
                        "reason": "PLUGIN_LICENSE_ERROR",
                        "message": "The Parent Link is only available to Jira Premium users."
                    }
                },
                "customfield_10019": "0|i000bj:",
                "aggregatetimeoriginalestimate": null,
                "timeestimate": null,
                "versions": [],
                "issuelinks": [],
                "assignee": {
                    "self": "https://d3securitycyber.atlassian.net/rest/api/2/user?accountId=***",
                    "accountId": "***",
                    "avatarUrls": {
                        "48x48": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-4.png",
                        "24x24": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-4.png",
                        "16x16": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-4.png",
                        "32x32": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-4.png"
                    },
                    "displayName": "Pulkit Sahni",
                    "active": true,
                    "timeZone": "America/Vancouver",
                    "accountType": "atlassian"
                },
                "updated": "2021-05-27T14:05:02.705-07:00",
                "status": {
                    "self": "https://d3securitycyber.atlassian.net/rest/api/2/status/***",
                    "description": "",
                    "iconUrl": "https://d3securitycyber.atlassian.net/",
                    "name": "Backlog",
                    "id": "***",
                    "statusCategory": {
                        "self": "https://d3securitycyber.atlassian.net/rest/api/2/statuscategory/2",
                        "id": 2,
                        "key": "new",
                        "colorName": "blue-gray",
                        "name": "To Do"
                    }
                },
                "components": [],
                "timeoriginalestimate": null,
                "description": "Creating of an issue using project keys and issue type names using the REST API",
                "customfield_10010": null,
                "customfield_10014": null,
                "customfield_10015": null,
                "customfield_10005": null,
                "customfield_10006": null,
                "security": null,
                "customfield_10007": null,
                "customfield_10008": null,
                "customfield_10009": null,
                "aggregatetimeestimate": null,
                "summary": "REST ye merry gentlemen.",
                "creator": {
                    "self": "https://d3securitycyber.atlassian.net/rest/api/2/user?accountId=***",
                    "accountId": "***",
                    "emailAddress": "test@example.com",
                    "avatarUrls": {
                        "48x48": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png",
                        "24x24": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png",
                        "16x16": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png",
                        "32x32": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png"
                    },
                    "displayName": "D3 System Engineer Team",
                    "active": true,
                    "timeZone": "America/Vancouver",
                    "accountType": "atlassian"
                },
                "subtasks": [],
                "reporter": {
                    "self": "https://d3securitycyber.atlassian.net/rest/api/2/user?accountId=***",
                    "accountId": "***",
                    "emailAddress": "test@example.com",
                    "avatarUrls": {
                        "48x48": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png",
                        "24x24": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png",
                        "16x16": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png",
                        "32x32": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png"
                    },
                    "displayName": "D3 System Engineer Team",
                    "active": true,
                    "timeZone": "America/Vancouver",
                    "accountType": "atlassian"
                },
                "aggregateprogress": {
                    "progress": 0,
                    "total": 0
                },
                "customfield_10000": "{}",
                "customfield_10001": null,
                "customfield_10002": null,
                "customfield_10003": null,
                "customfield_10004": null,
                "environment": null,
                "duedate": null,
                "progress": {
                    "progress": 0,
                    "total": 0
                },
                "votes": {
                    "self": "https://d3securitycyber.atlassian.net/rest/api/2/issue/***/votes",
                    "votes": 0,
                    "hasVoted": false
                }
            }
        },
        {
            "expand": "operations,versionedRepresentations,editmeta,changelog,renderedFields",
            "id": "***",
            "self": "https://d3securitycyber.atlassian.net/rest/api/2/issue/***",
            "key": "***",
            "fields": {
                "statuscategorychangedate": "2020-06-04T10:59:33.656-07:00",
                "issuetype": {
                    "self": "https://d3securitycyber.atlassian.net/rest/api/2/issuetype/***",
                    "id": "***",
                    "description": "A small, distinct piece of work.",
                    "iconUrl": "https://d3securitycyber.atlassian.net/secure/viewavatar?size=medium&avatarId=***&avatarType=issuetype",
                    "name": "Task",
                    "subtask": false,
                    "avatarId": ***,
                    "hierarchyLevel": 0
                },
                "timespent": null,
                "customfield_10030": null,
                "project": {
                    "self": "https://d3securitycyber.atlassian.net/rest/api/2/project/****",
                    "id": "***",
                    "key": "***",
                    "name": "d3security",
                    "projectTypeKey": "software",
                    "simplified": false,
                    "avatarUrls": {
                        "48x48": "https://d3securitycyber.atlassian.net/secure/projectavatar?pid=***&avatarId=***",
                        "24x24": "https://d3securitycyber.atlassian.net/secure/projectavatar?size=small&s=small&pid=**&avatarId=***",
                        "16x16": "https://d3securitycyber.atlassian.net/secure/projectavatar?size=xsmall&s=xsmall&pid=***&avatarId=***",
                        "32x32": "https://d3securitycyber.atlassian.net/secure/projectavatar?size=medium&s=medium&pid=***&avatarId=***"
                    }
                },
                "customfield_10031": null,
                "customfield_10032": null,
                "fixVersions": [],
                "customfield_10034": null,
                "aggregatetimespent": null,
                "customfield_10035": null,
                "resolution": null,
                "customfield_10027": null,
                "resolutiondate": null,
                "workratio": -1,
                "watches": {
                    "self": "https://d3securitycyber.atlassian.net/rest/api/2/issue/***/watchers",
                    "watchCount": 1,
                    "isWatching": false
                },
                "lastViewed": null,
                "created": "2020-06-04T10:59:33.452-07:00",
                "customfield_10020": null,
                "customfield_10021": null,
                "customfield_10022": null,
                "priority": {
                    "self": "https://d3securitycyber.atlassian.net/rest/api/2/priority/3",
                    "iconUrl": "https://d3securitycyber.atlassian.net/images/icons/priorities/medium.svg",
                    "name": "Medium",
                    "id": "3"
                },
                "customfield_10023": null,
                "customfield_10024": null,
                "customfield_10025": [],
                "labels": [
                    "blitz_test",
                    "test2"
                ],
                "customfield_10026": null,
                "customfield_10016": null,
                "customfield_10017": null,
                "customfield_10018": {
                    "hasEpicLinkFieldDependency": false,
                    "showField": false,
                    "nonEditableReason": {
                        "reason": "PLUGIN_LICENSE_ERROR",
                        "message": "The Parent Link is only available to Jira Premium users."
                    }
                },
                "customfield_10019": "0|i0003b:",
                "aggregatetimeoriginalestimate": null,
                "timeestimate": null,
                "versions": [],
                "issuelinks": [],
                "assignee": null,
                "updated": "2021-04-06T17:57:36.339-07:00",
                "status": {
                    "self": "https://d3securitycyber.atlassian.net/rest/api/2/status/***",
                    "description": "",
                    "iconUrl": "https://d3securitycyber.atlassian.net/",
                    "name": "Backlog",
                    "id": "***",
                    "statusCategory": {
                        "self": "https://d3securitycyber.atlassian.net/rest/api/2/statuscategory/2",
                        "id": 2,
                        "key": "new",
                        "colorName": "blue-gray",
                        "name": "To Do"
                    }
                },
                "components": [],
                "timeoriginalestimate": null,
                "description": "Order entry fails when selecting supplier.",
                "customfield_10010": null,
                "customfield_10014": null,
                "customfield_10015": null,
                "customfield_10005": null,
                "customfield_10006": null,
                "security": null,
                "customfield_10007": null,
                "customfield_10008": null,
                "aggregatetimeestimate": null,
                "customfield_10009": null,
                "summary": "Orders still displaying in pending",
                "creator": {
                    "self": "https://d3securitycyber.atlassian.net/rest/api/2/user?accountId=***",
                    "accountId": "***",
                    "avatarUrls": {
                        "48x48": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-4.png",
                        "24x24": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-4.png",
                        "16x16": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-4.png",
                        "32x32": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-4.png"
                    },
                    "displayName": "Pulkit Sahni",
                    "active": true,
                    "timeZone": "America/Vancouver",
                    "accountType": "atlassian"
                },
                "subtasks": [],
                "reporter": {
                    "self": "https://d3securitycyber.atlassian.net/rest/api/2/user?accountId=***",
                    "accountId": "***",
                    "avatarUrls": {
                        "48x48": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-4.png",
                        "24x24": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-4.png",
                        "16x16": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-4.png",
                        "32x32": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-4.png"
                    },
                    "displayName": "Pulkit Sahni",
                    "active": true,
                    "timeZone": "America/Vancouver",
                    "accountType": "atlassian"
                },
                "customfield_10000": "{}",
                "aggregateprogress": {
                    "progress": 0,
                    "total": 0
                },
                "customfield_10001": null,
                "customfield_10002": null,
                "customfield_10003": null,
                "customfield_10004": null,
                "environment": null,
                "duedate": null,
                "progress": {
                    "progress": 0,
                    "total": 0
                },
                "votes": {
                    "self": "https://d3securitycyber.atlassian.net/rest/api/2/issue/***/votes",
                    "votes": 0,
                    "hasVoted": false
                }
            }
        }
    ]
}
Context Data

The data extracted from Raw Data converted into JSON format. Context Data may be identical to Raw Data in some cases.

D3 customizes the Context Data by extracting the data from path $.issues in API returned JSON.

It is recommended to refer to the Raw Data instead of Context Data, since it contains the complete API response data. D3 will deprecate Context Data in the future, and playbook tasks using Context Data will be replaced with Raw Data.

SAMPLE DATA

CODE
[
    {
        "expand": "operations,versionedRepresentations,editmeta,changelog,renderedFields",
        "id": "***",
        "self": "https://d3securitycyber.atlassian.net/rest/api/2/issue/***",
        "key": "***",
        "fields": {
            "statuscategorychangedate": "2021-05-27T14:05:03.256-07:00",
            "issuetype": {
                "self": "https://d3securitycyber.atlassian.net/rest/api/2/issuetype/***",
                "id": "***",
                "description": "A problem or error.",
                "iconUrl": "https://d3securitycyber.atlassian.net/secure/viewavatar?size=medium&avatarId=***&avatarType=issuetype",
                "name": "Bug",
                "subtask": false,
                "avatarId": ***,
                "hierarchyLevel": 0
            },
            "timespent": null,
            "customfield_10030": null,
            "project": {
                "self": "https://d3securitycyber.atlassian.net/rest/api/2/project/***",
                "id": "***",
                "key": "***",
                "name": "d3security",
                "projectTypeKey": "software",
                "simplified": false,
                "avatarUrls": {
                    "48x48": "https://d3securitycyber.atlassian.net/secure/projectavatar?pid=***&avatarId=***",
                    "24x24": "https://d3securitycyber.atlassian.net/secure/projectavatar?size=small&s=small&pid=***&avatarId=***",
                    "16x16": "https://d3securitycyber.atlassian.net/secure/projectavatar?size=xsmall&s=xsmall&pid=***&avatarId=***",
                    "32x32": "https://d3securitycyber.atlassian.net/secure/projectavatar?size=medium&s=medium&pid=***&avatarId=***"
                }
            },
            "customfield_10031": null,
            "customfield_10032": null,
            "fixVersions": [],
            "aggregatetimespent": null,
            "customfield_10034": null,
            "resolution": null,
            "customfield_10035": null,
            "customfield_10027": null,
            "resolutiondate": null,
            "workratio": -1,
            "lastViewed": null,
            "watches": {
                "self": "https://d3securitycyber.atlassian.net/rest/api/2/issue/***/watchers",
                "watchCount": 1,
                "isWatching": true
            },
            "created": "2021-05-27T14:05:02.705-07:00",
            "customfield_10020": null,
            "customfield_10021": null,
            "customfield_10022": null,
            "priority": {
                "self": "https://d3securitycyber.atlassian.net/rest/api/2/priority/3",
                "iconUrl": "https://d3securitycyber.atlassian.net/images/icons/priorities/medium.svg",
                "name": "Medium",
                "id": "3"
            },
            "customfield_10023": null,
            "customfield_10024": null,
            "customfield_10025": [],
            "labels": [],
            "customfield_10026": null,
            "customfield_10016": null,
            "customfield_10017": null,
            "customfield_10018": {
                "hasEpicLinkFieldDependency": false,
                "showField": false,
                "nonEditableReason": {
                    "reason": "PLUGIN_LICENSE_ERROR",
                    "message": "The Parent Link is only available to Jira Premium users."
                }
            },
            "customfield_10019": "0|i000bj:",
            "aggregatetimeoriginalestimate": null,
            "timeestimate": null,
            "versions": [],
            "issuelinks": [],
            "assignee": {
                "self": "https://d3securitycyber.atlassian.net/rest/api/2/user?accountId=***",
                "accountId": "***",
                "avatarUrls": {
                    "48x48": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-4.png",
                    "24x24": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-4.png",
                    "16x16": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-4.png",
                    "32x32": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-4.png"
                },
                "displayName": "Pulkit Sahni",
                "active": true,
                "timeZone": "America/Vancouver",
                "accountType": "atlassian"
            },
            "updated": "2021-05-27T14:05:02.705-07:00",
            "status": {
                "self": "https://d3securitycyber.atlassian.net/rest/api/2/status/***",
                "description": "",
                "iconUrl": "https://d3securitycyber.atlassian.net/",
                "name": "Backlog",
                "id": "***",
                "statusCategory": {
                    "self": "https://d3securitycyber.atlassian.net/rest/api/2/statuscategory/2",
                    "id": 2,
                    "key": "new",
                    "colorName": "blue-gray",
                    "name": "To Do"
                }
            },
            "components": [],
            "timeoriginalestimate": null,
            "description": "Creating of an issue using project keys and issue type names using the REST API",
            "customfield_10010": null,
            "customfield_10014": null,
            "customfield_10015": null,
            "customfield_10005": null,
            "customfield_10006": null,
            "security": null,
            "customfield_10007": null,
            "customfield_10008": null,
            "customfield_10009": null,
            "aggregatetimeestimate": null,
            "summary": "REST ye merry gentlemen.",
            "creator": {
                "self": "https://d3securitycyber.atlassian.net/rest/api/2/user?accountId=***",
                "accountId": "***",
                "emailAddress": "test@example.com",
                "avatarUrls": {
                    "48x48": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png",
                    "24x24": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png",
                    "16x16": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png",
                    "32x32": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png"
                },
                "displayName": "D3 System Engineer Team",
                "active": true,
                "timeZone": "America/Vancouver",
                "accountType": "atlassian"
            },
            "subtasks": [],
            "reporter": {
                "self": "https://d3securitycyber.atlassian.net/rest/api/2/user?accountId=***",
                "accountId": "***",
                "emailAddress": "test@example.com",
                "avatarUrls": {
                    "48x48": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png",
                    "24x24": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png",
                    "16x16": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png",
                    "32x32": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png"
                },
                "displayName": "D3 System Engineer Team",
                "active": true,
                "timeZone": "America/Vancouver",
                "accountType": "atlassian"
            },
            "aggregateprogress": {
                "progress": 0,
                "total": 0
            },
            "customfield_10000": "{}",
            "customfield_10001": null,
            "customfield_10002": null,
            "customfield_10003": null,
            "customfield_10004": null,
            "environment": null,
            "duedate": null,
            "progress": {
                "progress": 0,
                "total": 0
            },
            "votes": {
                "self": "https://d3securitycyber.atlassian.net/rest/api/2/issue/***/votes",
                "votes": 0,
                "hasVoted": false
            }
        }
    },
    {
        "expand": "operations,versionedRepresentations,editmeta,changelog,renderedFields",
        "id": "***",
        "self": "https://d3securitycyber.atlassian.net/rest/api/2/issue/***",
        "key": "***",
        "fields": {
            "statuscategorychangedate": "2020-06-04T10:59:33.656-07:00",
            "issuetype": {
                "self": "https://d3securitycyber.atlassian.net/rest/api/2/issuetype/***",
                "id": "***",
                "description": "A small, distinct piece of work.",
                "iconUrl": "https://d3securitycyber.atlassian.net/secure/viewavatar?size=medium&avatarId=***&avatarType=issuetype",
                "name": "Task",
                "subtask": false,
                "avatarId": ***,
                "hierarchyLevel": 0
            },
            "timespent": null,
            "customfield_10030": null,
            "project": {
                "self": "https://d3securitycyber.atlassian.net/rest/api/2/project/****",
                "id": "***",
                "key": "***",
                "name": "d3security",
                "projectTypeKey": "software",
                "simplified": false,
                "avatarUrls": {
                    "48x48": "https://d3securitycyber.atlassian.net/secure/projectavatar?pid=***&avatarId=***",
                    "24x24": "https://d3securitycyber.atlassian.net/secure/projectavatar?size=small&s=small&pid=**&avatarId=***",
                    "16x16": "https://d3securitycyber.atlassian.net/secure/projectavatar?size=xsmall&s=xsmall&pid=***&avatarId=***",
                    "32x32": "https://d3securitycyber.atlassian.net/secure/projectavatar?size=medium&s=medium&pid=***&avatarId=***"
                }
            },
            "customfield_10031": null,
            "customfield_10032": null,
            "fixVersions": [],
            "customfield_10034": null,
            "aggregatetimespent": null,
            "customfield_10035": null,
            "resolution": null,
            "customfield_10027": null,
            "resolutiondate": null,
            "workratio": -1,
            "watches": {
                "self": "https://d3securitycyber.atlassian.net/rest/api/2/issue/***/watchers",
                "watchCount": 1,
                "isWatching": false
            },
            "lastViewed": null,
            "created": "2020-06-04T10:59:33.452-07:00",
            "customfield_10020": null,
            "customfield_10021": null,
            "customfield_10022": null,
            "priority": {
                "self": "https://d3securitycyber.atlassian.net/rest/api/2/priority/3",
                "iconUrl": "https://d3securitycyber.atlassian.net/images/icons/priorities/medium.svg",
                "name": "Medium",
                "id": "3"
            },
            "customfield_10023": null,
            "customfield_10024": null,
            "customfield_10025": [],
            "labels": [
                "blitz_test",
                "test2"
            ],
            "customfield_10026": null,
            "customfield_10016": null,
            "customfield_10017": null,
            "customfield_10018": {
                "hasEpicLinkFieldDependency": false,
                "showField": false,
                "nonEditableReason": {
                    "reason": "PLUGIN_LICENSE_ERROR",
                    "message": "The Parent Link is only available to Jira Premium users."
                }
            },
            "customfield_10019": "0|i0003b:",
            "aggregatetimeoriginalestimate": null,
            "timeestimate": null,
            "versions": [],
            "issuelinks": [],
            "assignee": null,
            "updated": "2021-04-06T17:57:36.339-07:00",
            "status": {
                "self": "https://d3securitycyber.atlassian.net/rest/api/2/status/***",
                "description": "",
                "iconUrl": "https://d3securitycyber.atlassian.net/",
                "name": "Backlog",
                "id": "***",
                "statusCategory": {
                    "self": "https://d3securitycyber.atlassian.net/rest/api/2/statuscategory/2",
                    "id": 2,
                    "key": "new",
                    "colorName": "blue-gray",
                    "name": "To Do"
                }
            },
            "components": [],
            "timeoriginalestimate": null,
            "description": "Order entry fails when selecting supplier.",
            "customfield_10010": null,
            "customfield_10014": null,
            "customfield_10015": null,
            "customfield_10005": null,
            "customfield_10006": null,
            "security": null,
            "customfield_10007": null,
            "customfield_10008": null,
            "aggregatetimeestimate": null,
            "customfield_10009": null,
            "summary": "Orders still displaying in pending",
            "creator": {
                "self": "https://d3securitycyber.atlassian.net/rest/api/2/user?accountId=***",
                "accountId": "***",
                "avatarUrls": {
                    "48x48": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-4.png",
                    "24x24": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-4.png",
                    "16x16": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-4.png",
                    "32x32": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-4.png"
                },
                "displayName": "Pulkit Sahni",
                "active": true,
                "timeZone": "America/Vancouver",
                "accountType": "atlassian"
            },
            "subtasks": [],
            "reporter": {
                "self": "https://d3securitycyber.atlassian.net/rest/api/2/user?accountId=***",
                "accountId": "***",
                "avatarUrls": {
                    "48x48": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-4.png",
                    "24x24": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-4.png",
                    "16x16": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-4.png",
                    "32x32": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-4.png"
                },
                "displayName": "Pulkit Sahni",
                "active": true,
                "timeZone": "America/Vancouver",
                "accountType": "atlassian"
            },
            "customfield_10000": "{}",
            "aggregateprogress": {
                "progress": 0,
                "total": 0
            },
            "customfield_10001": null,
            "customfield_10002": null,
            "customfield_10003": null,
            "customfield_10004": null,
            "environment": null,
            "duedate": null,
            "progress": {
                "progress": 0,
                "total": 0
            },
            "votes": {
                "self": "https://d3securitycyber.atlassian.net/rest/api/2/issue/***/votes",
                "votes": 0,
                "hasVoted": false
            }
        }
    }
]
Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., will be extracted from Raw Data as Key Fields.
The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.

SAMPLE DATA

CODE
{
    "IssueIds": [
        "***",
        "***"
    ],
    "IssueKeys": [
        "***",
        "***"
    ],
    "CreatedTime": [
        "2021-07-02T11:30:11.069-07:00",
        "2021-07-02T11:23:24.191-07:00"
    ],
    "UpdatedTime": [
        "2021-07-02T11:30:44.361-07:00",
        "2021-07-02T11:25:19.952-07:00"
    ],
    "AssigneeDisplayNames": [
        "JonY",
        "JonY"
    ],
    "Statuses": [
        "Open",
        "Open"
    ]
}
Return Data

Indicates one of the possible command execution states: Successful, Successful with No Event Data 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

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE
Successful
Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

EXPAND

ID

SELF

KEY

FIELDS

operations,versionedRepresentations,editmeta,changelog,renderedFields


https://d3securitycyber.atlassian.net/rest/api/2/issue/***


{'statuscategorychangedate': '2021-05-27T14:05:03.256-07:00', 'issuetype': {'self': 'https://d3securitycyber.atlassian.net/rest/api/2/issuetype/***', 'id': '***', 'description': 'A problem or error.', 'iconUrl': 'https://d3securitycyber.atlassian.net/secure/viewavatar?size=medium&avatarId=***&avatarType=issuetype', 'name': 'Bug', 'subtask': False, 'avatarId': ***, 'hierarchyLevel': 0}, 'timespent': None, 'customfield_10030': None, 'project': {'self': 'https://d3securitycyber.atlassian.net/rest/api/2/project/***', 'id': '***', 'key': '***', 'name': 'd3security', 'projectTypeKey': 'software', 'simplified': False, 'avatarUrls': {'48x48': 'https://d3securitycyber.atlassian.net/secure/projectavatar?pid=***&avatarId=***', '24x24': 'https://d3securitycyber.atlassian.net/secure/projectavatar?size=small&s=small&pid=***&avatarId=***', '16x16': 'https://d3securitycyber.atlassian.net/secure/projectavatar?size=xsmall&s=xsmall&pid=***&avatarId=***', '32x32': 'https://d3securitycyber.atlassian.net/secure/projectavatar?size=medium&s=medium&pid=***&avatarId=***'}}, 'customfield_10031': None, 'customfield_10032': None, 'fixVersions': [], 'aggregatetimespent': None, 'customfield_10034': None, 'resolution': None, 'customfield_10035': None, 'customfield_10027': None, 'resolutiondate': None, 'workratio': -1, 'lastViewed': None, 'watches': {'self': 'https://d3securitycyber.atlassian.net/rest/api/2/issue/***/watchers', 'watchCount': 1, 'isWatching': True}, 'created': '2021-05-27T14:05:02.705-07:00', 'customfield_10020': None, 'customfield_10021': None, 'customfield_10022': None, 'priority': {'self': 'https://d3securitycyber.atlassian.net/rest/api/2/priority/3', 'iconUrl': 'https://d3securitycyber.atlassian.net/images/icons/priorities/medium.svg', 'name': 'Medium', 'id': '3'}, 'customfield_10023': None, 'customfield_10024': None, 'customfield_10025': [], 'labels': [], 'customfield_10026': None, 'customfield_10016': None, 'customfield_10017': None, 'customfield_10018': {'hasEpicLinkFieldDependency': False, 'showField': False, 'nonEditableReason': {'reason': 'PLUGIN_LICENSE_ERROR', 'message': 'The Parent Link is only available to Jira Premium users.'}}, 'customfield_10019': '0|***:', 'aggregatetimeoriginalestimate': None, 'timeestimate': None, 'versions': [], 'issuelinks': [], 'assignee': {'self': 'https://d3securitycyber.atlassian.net/rest/api/2/user?accountId=***', 'accountId': '***', 'avatarUrls': {'48x48': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-4.png', '24x24': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-4.png', '16x16': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-4.png', '32x32': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-4.png'}, 'displayName': 'Pulkit Sahni', 'active': True, 'timeZone': 'America/Vancouver', 'accountType': 'atlassian'}, 'updated': '2021-05-27T14:05:02.705-07:00', 'status': {'self': 'https://d3securitycyber.atlassian.net/rest/api/2/status/***', 'description': '', 'iconUrl': 'https://d3securitycyber.atlassian.net/', 'name': 'Backlog', 'id': '***', 'statusCategory': {'self': 'https://d3securitycyber.atlassian.net/rest/api/2/statuscategory/2', 'id': 2, 'key': 'new', 'colorName': 'blue-gray', 'name': 'To Do'}}, 'components': [], 'timeoriginalestimate': None, 'description': 'Creating of an issue using project keys and issue type names using the REST API', 'customfield_10010': None, 'customfield_10014': None, 'customfield_10015': None, 'customfield_10005': None, 'customfield_10006': None, 'security': None, 'customfield_10007': None, 'customfield_10008': None, 'customfield_10009': None, 'aggregatetimeestimate': None, 'summary': 'REST ye merry gentlemen.', 'creator': {'self': 'https://d3securitycyber.atlassian.net/rest/api/2/user?accountId=***', 'accountId': '***', 'emailAddress': 'test@example.com', 'avatarUrls': {'48x48': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png', '24x24': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png', '16x16': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png', '32x32': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png'}, 'displayName': 'D3 System Engineer Team', 'active': True, 'timeZone': 'America/Vancouver', 'accountType': 'atlassian'}, 'subtasks': [], 'reporter': {'self': 'https://d3securitycyber.atlassian.net/rest/api/2/user?accountId=***', 'accountId': '***', 'emailAddress': 'test@example.com', 'avatarUrls': {'48x48': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png', '24x24': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png', '16x16': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png', '32x32': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png'}, 'displayName': 'D3 System Engineer Team', 'active': True, 'timeZone': 'America/Vancouver', 'accountType': 'atlassian'}, 'aggregateprogress': {'progress': 0, 'total': 0}, 'customfield_10000': '{}', 'customfield_10001': None, 'customfield_10002': None, 'customfield_10003': None, 'customfield_10004': None, 'environment': None, 'duedate': None, 'progress': {'progress': 0, 'total': 0}, 'votes': {'self': 'https://d3securitycyber.atlassian.net/rest/api/2/issue/D3SEC-43/votes', 'votes': 0, 'hasVoted': False}}

operations,versionedRepresentations,editmeta,changelog,renderedFields


https://d3securitycyber.atlassian.net/rest/api/2/issue/***


{'statuscategorychangedate': '2020-06-04T10:59:33.656-07:00', 'issuetype': {'self': 'https://d3securitycyber.atlassian.net/rest/api/2/issuetype/***', 'id': '***', 'description': 'A small, distinct piece of work.', 'iconUrl': 'https://d3securitycyber.atlassian.net/secure/viewavatar?size=medium&avatarId=***&avatarType=issuetype', 'name': 'Task', 'subtask': False, 'avatarId': ***, 'hierarchyLevel': 0}, 'timespent': None, 'customfield_10030': None, 'project': {'self': 'https://d3securitycyber.atlassian.net/rest/api/2/project/***', 'id': '***', 'key': '***', 'name': 'd3security', 'projectTypeKey': 'software', 'simplified': False, 'avatarUrls': {'48x48': 'https://d3securitycyber.atlassian.net/secure/projectavatar?pid=**00&avatarId=***', '24x24': 'https://d3securitycyber.atlassian.net/secure/projectavatar?size=small&s=small&pid=***&avatarId=***', '16x16': 'https://d3securitycyber.atlassian.net/secure/projectavatar?size=xsmall&s=xsmall&pid=**&avatarId=***', '32x32': 'https://d3securitycyber.atlassian.net/secure/projectavatar?size=medium&s=medium&pid=***&avatarId=***'}}, 'customfield_10031': None, 'customfield_10032': None, 'fixVersions': [], 'customfield_10034': None, 'aggregatetimespent': None, 'customfield_10035': None, 'resolution': None, 'customfield_10027': None, 'resolutiondate': None, 'workratio': -1, 'watches': {'self': 'https://d3securitycyber.atlassian.net/rest/api/2/issue/***/watchers', 'watchCount': 1, 'isWatching': False}, 'lastViewed': None, 'created': '2020-06-04T10:59:33.452-07:00', 'customfield_10020': None, 'customfield_10021': None, 'customfield_10022': None, 'priority': {'self': 'https://d3securitycyber.atlassian.net/rest/api/2/priority/3', 'iconUrl': 'https://d3securitycyber.atlassian.net/images/icons/priorities/medium.svg', 'name': 'Medium', 'id': '3'}, 'customfield_10023': None, 'customfield_10024': None, 'customfield_10025': [], 'labels': ['blitz_test', 'test2'], 'customfield_10026': None, 'customfield_10016': None, 'customfield_10017': None, 'customfield_10018': {'hasEpicLinkFieldDependency': False, 'showField': False, 'nonEditableReason': {'reason': 'PLUGIN_LICENSE_ERROR', 'message': 'The Parent Link is only available to Jira Premium users.'}}, 'customfield_10019': '0|***:', 'aggregatetimeoriginalestimate': None, 'timeestimate': None, 'versions': [], 'issuelinks': [], 'assignee': None, 'updated': '2021-04-06T17:57:36.339-07:00', 'status': {'self': 'https://d3securitycyber.atlassian.net/rest/api/2/status/***', 'description': '', 'iconUrl': 'https://d3securitycyber.atlassian.net/', 'name': 'Backlog', 'id': '***', 'statusCategory': {'self': 'https://d3securitycyber.atlassian.net/rest/api/2/statuscategory/2', 'id': 2, 'key': 'new', 'colorName': 'blue-gray', 'name': 'To Do'}}, 'components': [], 'timeoriginalestimate': None, 'description': 'Order entry fails when selecting supplier.', 'customfield_10010': None, 'customfield_10014': None, 'customfield_10015': None, 'customfield_10005': None, 'customfield_10006': None, 'security': None, 'customfield_10007': None, 'customfield_10008': None, 'aggregatetimeestimate': None, 'customfield_10009': None, 'summary': 'Orders still displaying in pending', 'creator': {'self': 'https://d3securitycyber.atlassian.net/rest/api/2/user?accountId=***', 'accountId': '***', 'avatarUrls': {'48x48': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-4.png', '24x24': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-4.png', '16x16': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-4.png', '32x32': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-4.png'}, 'displayName': 'Pulkit Sahni', 'active': True, 'timeZone': 'America/Vancouver', 'accountType': 'atlassian'}, 'subtasks': [], 'reporter': {'self': 'https://d3securitycyber.atlassian.net/rest/api/2/user?accountId=***', 'accountId': '***', 'avatarUrls': {'48x48': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-4.png', '24x24': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-4.png', '16x16': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-4.png', '32x32': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FPS-4.png'}, 'displayName': 'Pulkit Sahni', 'active': True, 'timeZone': 'America/Vancouver', 'accountType': 'atlassian'}, 'customfield_10000': '{}', 'aggregateprogress': {'progress': 0, 'total': 0}, 'customfield_10001': None, 'customfield_10002': None, 'customfield_10003': None, 'customfield_10004': None, 'environment': None, 'duedate': None, 'progress': {'progress': 0, 'total': 0}, 'votes': {'self': 'https://d3securitycyber.atlassian.net/rest/api/2/issue/***/votes', 'votes': 0, 'hasVoted': False}}

Fetch Event Field Mapping

Please note that Fetch Event commands require event field mapping. Field mapping plays a key role in the data normalization process part of the event pipeline. Field mapping converts the original data fields from the different providers to the D3 fields which are standardized by the D3 Model. Please refer to Event and Incident Intake Field Mapping for details.

If you require a custom field mapping, click +Add Field to add a custom field mapping. You may also remove built-in field mappings by clicking x. Please note that two underscore characters will automatically prefix the defined Field Name as the System Name for a custom field mapping. Additionally, if an input Field Name contains any spaces, they will automatically be replaced with underscores for the corresponding System Name.

As a system integration, the Jira integration has some pre-configured field mappings for default field mapping.

  • Default Event Source
    The Default Event Source is the default set of field mappings that are applied when this fetch event command is executed. For out-of-the-box integrations, you will find a set of field mapping provided by the system. Default event source provides field mappings for common fields from fetched events. The default event source has a "Main Event JSON Path" (i.e., $.issues) that is used to extract a batch of events from the response raw data. Click Edit Event Source to view the "Main Event JSON Path".

    • Main Event JSON Path: $.issues
      The Main Event JSON Path determines the root path where the system starts parsing raw response data into D3 event data. The JSON path begins with $, representing the root element. The path is formed by appending a sequence of child elements to $, each separated by a dot (.). Square brackets with nested quotation marks ([ā€˜...']) should be used to separate child elements in JSON arrays.
      For example, the root node of a JSON Path is issues. The child node denoting the Original event ID field would be id. Putting it together, the JSON Path 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 you 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.

[ "test@example.com" ]

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON
{
    "users": [
        {
            "accountId": "***",
            "accountType": "atlassian",
            "html": "D3 System Engineer Team - test@example.com",
            "displayName": "D3 System Engineer Team"
        }
    ]
}
Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., will be extracted from Raw Data as Key Fields.
The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.

SAMPLE DATA

CODE
{
    "AccountIDs": [
        "***"
    ],
    "AccountDisplayNames": [
        "D3 System Engineer Team"
    ]
}
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

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE
Successful
Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

users

  • {'accountId': '***', 'accountType': 'atlassian', 'html': 'D3 System Engineer Team - test@example.com', 'displayName': 'D3 System Engineer Team'}

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 you 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

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

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

  • If the command runs successfully with no results, the specified issue may not have any existing comments.

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.

[ "***" ]

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON
[
    {
        "startAt": 0,
        "maxResults": ***,
        "key": "***",
        "total": 2,
        "comments": [
            {
                "self": "https://team-***.atlassian.net/rest/api/3/issue/10037/comment/***",
                "id": "10015",
                "author": {
                    "self": "https://team-***.atlassian.net/rest/api/3/user?accountId=***",
                    "accountId": "***",
                    "emailAddress": "test@example.com",
                    "avatarUrls": {
                        "48x48": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png",
                        "24x24": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png",
                        "16x16": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png",
                        "32x32": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png"
                    },
                    "displayName": "D3 System Engineer Team",
                    "active": true,
                    "timeZone": "CET",
                    "accountType": "atlassian"
                },
                "body": {
                    "type": "doc",
                    "version": 1,
                    "content": [
                        {
                            "type": "paragraph",
                            "content": [
                                {
                                    "text": "Hello World 20220808a v3",
                                    "type": "text"
                                }
                            ]
                        }
                    ]
                },
                "updateAuthor": {
                    "self": "https://team-***.atlassian.net/rest/api/3/user?accountId=***",
                    "accountId": "***",
                    "emailAddress": "test@example.com",
                    "avatarUrls": {
                        "48x48": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png",
                        "24x24": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png",
                        "16x16": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png",
                        "32x32": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png"
                    },
                    "displayName": "D3 System Engineer Team",
                    "active": true,
                    "timeZone": "CET",
                    "accountType": "atlassian"
                },
                "created": "2022-08-09T00:36:41.733+0000",
                "updated": "2022-08-09T00:36:41.733+0000",
                "visibility": {
                    "type": "group",
                    "value": "powerful-users",
                    "identifier": "***-***-***-***-***"
                },
                "jsdPublic": true
            },
            {
                "self": "https://team-***.atlassian.net/rest/api/3/issue/**/comment/**",
                "id": "***",
                "author": {
                    "self": "https://team-***.atlassian.net/rest/api/3/user?accountId=***",
                    "accountId": "***",
                    "emailAddress": "test@example.com",
                    "avatarUrls": {
                        "48x48": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png",
                        "24x24": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png",
                        "16x16": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png",
                        "32x32": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png"
                    },
                    "displayName": "D3 System Engineer Team",
                    "active": true,
                    "timeZone": "CET",
                    "accountType": "atlassian"
                },
                "body": {
                    "version": 1,
                    "type": "doc",
                    "content": [
                        {
                            "type": "paragraph",
                            "content": [
                                {
                                    "type": "text",
                                    "text": "Hello World! v2"
                                }
                            ]
                        }
                    ]
                },
                "updateAuthor": {
                    "self": "https://team-***.atlassian.net/rest/api/3/user?accountId=***",
                    "accountId": "***",
                    "emailAddress": "test@example.com",
                    "avatarUrls": {
                        "48x48": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png",
                        "24x24": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png",
                        "16x16": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png",
                        "32x32": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png"
                    },
                    "displayName": "D3 System Engineer Team",
                    "active": true,
                    "timeZone": "CET",
                    "accountType": "atlassian"
                },
                "created": "2022-08-09T00:38:33.282+0000",
                "updated": "2022-08-09T00:38:33.282+0000",
                "visibility": {
                    "type": "group",
                    "value": "powerful-users",
                    "identifier": "***-***-***-***-***"
                },
                "jsdPublic": true
            }
        ]
    }
]
Context Data

The data extracted from Raw Data converted into JSON format. Context Data may be identical to Raw The data extracted from Raw Data converted into JSON format. Context Data may be identical to Raw Data in some cases.

It is recommended to refer to the Raw Data instead of Context Data, since it contains the complete API response data. D3 will deprecate Context Data in the future, and playbook tasks using Context Data will be replaced with Raw Data.

SAMPLE DATA

CODE
No Sample Data
Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., will be extracted from Raw Data as Key Fields.
The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.

SAMPLE DATA

CODE
{
    "IssueKeys": [
        "***"
    ]
}
Return Data

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

The Partially Successful state only occurs when a command's input accepts an array of items (e.g. an array of issue keys) and one or more items within the array return an error from the API request.

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

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE
Successful
Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

STARTAT

MAXRESULTS

KEY

TOTAL

COMMENTS

0



2

[{'self': 'https://team-***.atlassian.net/rest/api/3/issue/***/comment/***', 'id': '***', 'author': {'self': 'https://team-***.atlassian.net/rest/api/3/user?accountId=***', 'accountId': '***', 'emailAddress': 'test@example.com', 'avatarUrls': {'48x48': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png', '24x24': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png', '16x16': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png', '32x32': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png'}, 'displayName': 'D3 System Engineer Team', 'active': True, 'timeZone': 'CET', 'accountType': 'atlassian'}, 'body': {'type': 'doc', 'version': 1, 'content': [{'type': 'paragraph', 'content': [{'text': 'Hello World 20220808a v3', 'type': 'text'}]}]}, 'updateAuthor': {'self': 'https://team-***.atlassian.net/rest/api/3/user?accountId=***', 'accountId': '&&&', 'emailAddress': 'test@example.com', 'avatarUrls': {'48x48': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png', '24x24': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png', '16x16': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png', '32x32': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png'}, 'displayName': 'D3 System Engineer Team', 'active': True, 'timeZone': 'CET', 'accountType': 'atlassian'}, 'created': '2022-08-09T00:36:41.733+0000', 'updated': '2022-08-09T00:36:41.733+0000', 'visibility': {'type': 'group', 'value': 'powerful-users', 'identifier': '***-***-***-***-***'}, 'jsdPublic': True}, {'self': 'https://team-***.atlassian.net/rest/api/3/issue/***/comment/***', 'id': '***', 'author': {'self': 'https://team-***.atlassian.net/rest/api/3/user?accountId=***', 'accountId': '***', 'emailAddress': 'test@example.com', 'avatarUrls': {'48x48': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png', '24x24': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png', '16x16': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png', '32x32': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png'}, 'displayName': 'D3 System Engineer Team', 'active': True, 'timeZone': 'CET', 'accountType': 'atlassian'}, 'body': {'version': 1, 'type': 'doc', 'content': [{'type': 'paragraph', 'content': [{'type': 'text', 'text': 'Hello World! v2'}]}]}, 'updateAuthor': {'self': 'https://team-***.atlassian.net/rest/api/3/user?accountId=***', 'accountId': '***', 'emailAddress': 'test@example.com', 'avatarUrls': {'48x48': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png', '24x24': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png', '16x16': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png', '32x32': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png'}, 'displayName': 'D3 System Engineer Team', 'active': True, 'timeZone': 'CET', 'accountType': 'atlassian'}, 'created': '2022-08-09T00:38:33.282+0000', 'updated': '2022-08-09T00:38:33.282+0000', 'visibility': {'type': 'group', 'value': 'powerful-users', 'identifier': '***-***-***-***-***'}, 'jsdPublic': True}]

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 you 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

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON
Jira_getCreateMeta_raw_sample.json
Context Data

The data extracted from Raw Data converted into JSON format. Context Data may be identical to Raw Data in some cases.

D3 customizes the Context Data by extracting the data from path $.projects in API returned JSON.

It is recommended to refer to the Raw Data instead of Context Data, since it contains the complete API response data. D3 will deprecate Context Data in the future, and playbook tasks using Context Data will be replaced with Raw Data.

SAMPLE DATA

CODE
Jira_getCreateMeta_context_sample.json
Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., will be extracted from Raw Data as Key Fields.
The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.

SAMPLE DATA

CODE
{
    "ProjectIds": [
        "***",
        "***",
        "***"
    ],
    "ProjectNames": [
        "20220804-Test",
        "ITSM sample space",
        "testProject"
    ]
}
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

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE
Successful
Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

CODE
No Sample Data

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 you 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 is not currently compatible with the version 3 of Jira's API. It is recommended to build a separate connection with API version 2 to use this command.

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

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

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.

[ "***" ]

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

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON
Jira_getIssue_v2_raw_sample.json
Context Data

The data extracted from Raw Data converted into JSON format. Context Data may be identical to Raw Data in some cases.

It is recommended to refer to the Raw Data instead of Context Data, since it contains the complete API response data. D3 will deprecate Context Data in the future, and playbook tasks using Context Data will be replaced with Raw Data.

SAMPLE DATA

CODE
No Sample Data
Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., will be extracted from Raw Data as Key Fields.
The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.

SAMPLE DATA

CODE
{
    "IssueId": ***,
    "IssueKey": "***"
}
Return Data

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

The Partially Successful state only occurs when a command's input accepts an array of items (e.g. an array of IP addresses) and one or more items within the array return an error from the API request.

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

You can view more details about an error in the Error tab.
Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE
Successful
Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

CODE
No Sample Data

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 you 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.

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 Issue Keys. Issue Key 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 results, your input issue may not have 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

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON
{
    "expand": "renderedFields,names,schema,operations,editmeta,changelog,versionedRepresentations",
    "id": "***",
    "self": "https://team-***.atlassian.net/rest/api/2/issue/***",
    "key": "***",
    "fields": {
        "issuelinks": [
            {
                "id": "***",
                "self": "https://team-***.atlassian.net/rest/api/2/issueLink/***",
                "type": {
                    "id": "***",
                    "name": "Duplicate",
                    "inward": "is duplicated by",
                    "outward": "duplicates",
                    "self": "https://team-***.atlassian.net/rest/api/2/issueLinkType/***"
                },
                "outwardIssue": {
                    "id": "***",
                    "key": "***",
                    "self": "https://team-***.atlassian.net/rest/api/2/issue/***",
                    "fields": {
                        "summary": "Issue's subtask1",
                        "status": {
                            "self": "https://team-***.atlassian.net/rest/api/2/status/***",
                            "description": "",
                            "iconUrl": "https://team-***.atlassian.net/",
                            "name": "Backlog",
                            "id": "***",
                            "statusCategory": {
                                "self": "https://team-***.atlassian.net/rest/api/2/statuscategory/2",
                                "id": 2,
                                "key": "new",
                                "colorName": "blue-gray",
                                "name": "To Do"
                            }
                        },
                        "priority": {
                            "self": "https://team-***.atlassian.net/rest/api/2/priority/3",
                            "iconUrl": "https://team-***.atlassian.net/images/icons/priorities/medium.svg",
                            "name": "Medium",
                            "id": "3"
                        },
                        "issuetype": {
                            "self": "https://team-***.atlassian.net/rest/api/2/issuetype/***",
                            "id": "***",
                            "description": "The sub-task of the issue",
                            "iconUrl": "https://team-***.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/***?size=medium",
                            "name": "Sub-task",
                            "subtask": true,
                            "avatarId": ***,
                            "hierarchyLevel": -1
                        }
                    }
                }
            }
        ]
    }
}
Context Data

The data extracted from Raw Data converted into JSON format. Context Data may be identical to Raw Data in some cases.

D3 customizes the Context Data by extracting the data from path $.fields.issuelinks in API returned JSON.

It is recommended to refer to the Raw Data instead of Context Data, since it contains the complete API response data. D3 will deprecate Context Data in the future, and playbook tasks using Context Data will be replaced with Raw Data.

SAMPLE DATA

CODE
[
    {
        "id": "***",
        "self": "https://team-***.atlassian.net/rest/api/2/issueLink/***",
        "type": {
            "id": "***",
            "name": "Duplicate",
            "inward": "is duplicated by",
            "outward": "duplicates",
            "self": "https://team-***.atlassian.net/rest/api/2/issueLinkType/***"
        },
        "outwardIssue": {
            "id": "***",
            "key": "***",
            "self": "https://team-***.atlassian.net/rest/api/2/issue/***",
            "fields": {
                "summary": "Issue's subtask1",
                "status": {
                    "self": "https://team-***.atlassian.net/rest/api/2/status/***",
                    "description": "",
                    "iconUrl": "https://team-***.atlassian.net/",
                    "name": "Backlog",
                    "id": "***",
                    "statusCategory": {
                        "self": "https://team-***.atlassian.net/rest/api/2/statuscategory/2",
                        "id": 2,
                        "key": "new",
                        "colorName": "blue-gray",
                        "name": "To Do"
                    }
                },
                "priority": {
                    "self": "https://team-***.atlassian.net/rest/api/2/priority/3",
                    "iconUrl": "https://team-***.atlassian.net/images/icons/priorities/medium.svg",
                    "name": "Medium",
                    "id": "3"
                },
                "issuetype": {
                    "self": "https://team-***.atlassian.net/rest/api/2/issuetype/***",
                    "id": "***",
                    "description": "The sub-task of the issue",
                    "iconUrl": "https://team-***.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/***?size=medium",
                    "name": "Sub-task",
                    "subtask": true,
                    "avatarId": ***,
                    "hierarchyLevel": -1
                }
            }
        }
    }
]
Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., will be extracted from Raw Data as Key Fields.
The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.

SAMPLE DATA

CODE
{
    "LinkIds": [
        "***"
    ],
    "LinkTypeIds": [
        "***"
    ],
    "LinkTypeNames": [
        "Duplicate"
    ],
    "LinkTypeInwards": [
        "is duplicated by"
    ],
    "LinkTypeOutwards": [
        "duplicates"
    ],
    "InwardIssueKeys": [
        "***"
    ],
    "OutwardIssueKeys": [
        "***"
    ]
}
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

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE
Successful
Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

ID

SELF

TYPE

OUTWARDISSUE


https://team-***.atlassian.net/rest/api/2/issueLink/***

{'id': '***', 'name': 'Duplicate', 'inward': 'is duplicated by', 'outward': 'duplicates', 'self': 'https://team-***.atlassian.net/rest/api/2/issueLinkType/***'}

{'id': '***', 'key': '***', 'self': 'https://team-***.atlassian.net/rest/api/2/issue/***', 'fields': {'summary': "Issue's subtask1", 'status': {'self': 'https://team-***.atlassian.net/rest/api/2/status/***', 'description': '', 'iconUrl': 'https://team-***.atlassian.net/', 'name': 'Backlog', 'id': '***', 'statusCategory': {'self': 'https://team-***.atlassian.net/rest/api/2/statuscategory/2', 'id': 2, 'key': 'new', 'colorName': 'blue-gray', 'name': 'To Do'}}, 'priority': {'self': 'https://team-***.atlassian.net/rest/api/2/priority/3', 'iconUrl': 'https://team-***.atlassian.net/images/icons/priorities/medium.svg', 'name': 'Medium', 'id': '3'}, 'issuetype': {'self': 'https://team-***.atlassian.net/rest/api/2/issuetype/***', 'id': '***', 'description': 'The sub-task of the issue', 'iconUrl': 'https://team-***.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/***?size=medium', 'name': 'Sub-task', 'subtask': True, 'avatarId': ***, 'hierarchyLevel': -1}}}

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 you 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 is not currently compatible with the version 3 of Jira's API. It is recommended to build a separate connection with API version 2 to use this command.

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

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

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.

[ "***" ]

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON
[
    {
        "expand": "transitions",
        "IssueKey": "***",
        "transitions": [
            {
                "id": "11",
                "name": "Backlog",
                "to": {
                    "self": "https://api.atlassian.com/ex/jira/***-***-***-***-***/rest/api/3/status/***",
                    "description": "",
                    "iconUrl": "https://api.atlassian.com/ex/jira/***-***-***-***-***",
                    "name": "Backlog",
                    "id": "***",
                    "statusCategory": {
                        "self": "https://api.atlassian.com/ex/jira/***-***-***-***-***/rest/api/3/statuscategory/2",
                        "id": 2,
                        "key": "new",
                        "colorName": "blue-gray",
                        "name": "To Do"
                    }
                },
                "hasScreen": false,
                "isGlobal": true,
                "isInitial": false,
                "isAvailable": true,
                "isConditional": false,
                "isLooped": false
            },
            {
                "id": "21",
                "name": "Selected for Development",
                "to": {
                    "self": "https://api.atlassian.com/ex/jira/***-***-***-***-***/rest/api/3/status/***",
                    "description": "",
                    "iconUrl": "https://api.atlassian.com/ex/jira/***-***-***-***-***/",
                    "name": "Selected for Development",
                    "id": "***",
                    "statusCategory": {
                        "self": "https://api.atlassian.com/ex/jira/***-***-***-***-***/rest/api/3/statuscategory/2",
                        "id": 2,
                        "key": "new",
                        "colorName": "blue-gray",
                        "name": "To Do"
                    }
                },
                "hasScreen": false,
                "isGlobal": true,
                "isInitial": false,
                "isAvailable": true,
                "isConditional": false,
                "isLooped": false
            },
            {
                "id": "***",
                "name": "In Progress",
                "to": {
                    "self": "https://api.atlassian.com/ex/jira/***-***-***-***-***/rest/api/3/status/3",
                    "description": "This issue is being actively worked on at the moment by the assignee.",
                    "iconUrl": "https://team-***.atlassian.net/images/icons/statuses/inprogress.png",
                    "name": "In Progress",
                    "id": "3",
                    "statusCategory": {
                        "self": "https://api.atlassian.com/ex/jira/***-***-***-***-***/rest/api/3/statuscategory/4",
                        "id": 4,
                        "key": "indeterminate",
                        "colorName": "yellow",
                        "name": "In Progress"
                    }
                },
                "hasScreen": false,
                "isGlobal": true,
                "isInitial": false,
                "isAvailable": true,
                "isConditional": false,
                "isLooped": false
            },
            {
                "id": "**",
                "name": "Done",
                "to": {
                    "self": "https://api.atlassian.com/ex/jira/***-***-***-***-***/rest/api/3/status/***",
                    "description": "This was auto-generated by Jira Service Management during workflow import",
                    "iconUrl": "https://team-***.atlassian.net/images/icons/status_generic.gif",
                    "name": "Done",
                    "id": "***",
                    "statusCategory": {
                        "self": "https://api.atlassian.com/ex/jira/***-***-***-***-***/rest/api/3/statuscategory/3",
                        "id": 3,
                        "key": "done",
                        "colorName": "green",
                        "name": "Done"
                    }
                },
                "hasScreen": false,
                "isGlobal": true,
                "isInitial": false,
                "isAvailable": true,
                "isConditional": false,
                "isLooped": false
            }
        ]
    }
]
Context Data

The data extracted from Raw Data converted into JSON format. Context Data may be identical to Raw Data in some cases.

It is recommended to refer to the Raw Data instead of Context Data, since it contains the complete API response data. D3 will deprecate Context Data in the future, and playbook tasks using Context Data will be replaced with Raw Data.

SAMPLE DATA

CODE
No Sample Data
Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., will be extracted from Raw Data as Key Fields.
The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.

SAMPLE DATA

CODE
{
    "IssueKeys": [
        "***"
    ]
}
Return Data

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

The Partially Successful state only occurs when a command's input accepts an array of items (e.g. an array of IP addresses) and one or more items within the array return an error from the API request.

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

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE
Successful
Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

EXPAND

ISSUEKEY

TRANSITIONS

transitions


[{'id': '11', 'name': 'Backlog', 'to': {'self': 'https://api.atlassian.com/ex/jira/***-***-***-***-***/rest/api/3/status/***', 'description': '', 'iconUrl': 'https://api.atlassian.com/ex/jira/***-***-***-***-***/', 'name': 'Backlog', 'id': '***', 'statusCategory': {'self': 'https://api.atlassian.com/ex/jira/***-***-***-***-***/rest/api/3/statuscategory/2', 'id': 2, 'key': 'new', 'colorName': 'blue-gray', 'name': 'To Do'}}, 'hasScreen': False, 'isGlobal': True, 'isInitial': False, 'isAvailable': True, 'isConditional': False, 'isLooped': False}, {'id': '**', 'name': 'Selected for Development', 'to': {'self': 'https://api.atlassian.com/ex/jira/***-***-***-***-***/rest/api/3/status/**', 'description': '', 'iconUrl': 'https://api.atlassian.com/ex/jira/***-***-***-***-***/', 'name': 'Selected for Development', 'id': '***', 'statusCategory': {'self': 'https://api.atlassian.com/ex/jira/***-***-***-***-***/rest/api/3/statuscategory/2', 'id': 2, 'key': 'new', 'colorName': 'blue-gray', 'name': 'To Do'}}, 'hasScreen': False, 'isGlobal': True, 'isInitial': False, 'isAvailable': True, 'isConditional': False, 'isLooped': False}, {'id': '31', 'name': 'In Progress', 'to': {'self': 'https://api.atlassian.com/ex/jira/***-***-***-***-***/rest/api/3/status/3', 'description': 'This issue is being actively worked on at the moment by the assignee.', 'iconUrl': 'https://team-***.atlassian.net/images/icons/statuses/inprogress.png', 'name': 'In Progress', 'id': '3', 'statusCategory': {'self': 'https://api.atlassian.com/ex/jira/***-***-***-***-***/rest/api/3/statuscategory/4', 'id': 4, 'key': 'indeterminate', 'colorName': 'yellow', 'name': 'In Progress'}}, 'hasScreen': False, 'isGlobal': True, 'isInitial': False, 'isAvailable': True, 'isConditional': False, 'isLooped': False}, {'id': '41', 'name': 'Done', 'to': {'self': 'https://api.atlassian.com/ex/jira/***-***-***-***-***/rest/api/3/status/***', 'description': 'This was auto-generated by Jira Service Management during workflow import', 'iconUrl': 'https://team-***.atlassian.net/images/icons/status_generic.gif', 'name': 'Done', 'id': '***', 'statusCategory': {'self': 'https://api.atlassian.com/ex/jira/***-***-***-***-***/rest/api/3/statuscategory/3', 'id': 3, 'key': 'done', 'colorName': 'green', 'name': 'Done'}}, 'hasScreen': False, 'isGlobal': True, 'isInitial': False, 'isAvailable': True, 'isConditional': False, 'isLooped': False}]

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 you 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 to run. See Configure issue linking from Atlassian's documentation for more details.

  • First Issue Key, Second Issue Key and Link Description are required parameters to run this command.

    • Run the Search Issues command to obtain Issue Keys. Issue Key can be found in the returned raw data at the path $.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

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON
{
    "expand": "renderedFields,names,schema,operations,editmeta,changelog,versionedRepresentations",
    "id": "***",
    "self": "https://team-1596066689118.atlassian.net/rest/api/2/issue/***",
    "key": "***",
    "fields": {
        "issuelinks": [
            {
                "id": "***",
                "self": "https://team-***.atlassian.net/rest/api/2/issueLink/***",
                "type": {
                    "id": "***",
                    "name": "Blocks",
                    "inward": "is blocked by",
                    "outward": "blocks",
                    "self": "https://team-***.atlassian.net/rest/api/2/issueLinkType/***"
                },
                "outwardIssue": {
                    "id": "***",
                    "key": "***",
                    "self": "https://team-***.atlassian.net/rest/api/2/issue/***",
                    "fields": {
                        "summary": "Issue change 808b v2",
                        "status": {
                            "self": "https://team-***.atlassian.net/rest/api/2/status/***",
                            "description": "",
                            "iconUrl": "https://team-****.atlassian.net/",
                            "name": "Backlog",
                            "id": "10022",
                            "statusCategory": {
                                "self": "https://team-***.atlassian.net/rest/api/2/statuscategory/2",
                                "id": 2,
                                "key": "new",
                                "colorName": "blue-gray",
                                "name": "To Do"
                            }
                        },
                        "priority": {
                            "self": "https://team-***.atlassian.net/rest/api/2/priority/3",
                            "iconUrl": "https://team-***.atlassian.net/images/icons/priorities/medium.svg",
                            "name": "Medium",
                            "id": "3"
                        },
                        "issuetype": {
                            "self": "https://team-***.atlassian.net/rest/api/2/issuetype/***",
                            "id": "***",
                            "description": "The sub-task of the issue",
                            "iconUrl": "https://team-***.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/***?size=medium",
                            "name": "Sub-task",
                            "subtask": true,
                            "avatarId": ***,
                            "hierarchyLevel": -1
                        }
                    }
                }
            },
            {
                "id": "***",
                "self": "https://team-***.atlassian.net/rest/api/2/issueLink/***",
                "type": {
                    "id": "***",
                    "name": "Duplicate",
                    "inward": "is duplicated by",
                    "outward": "duplicates",
                    "self": "https://team-***.atlassian.net/rest/api/2/issueLinkType/***"
                },
                "inwardIssue": {
                    "id": "***",
                    "key": "***",
                    "self": "https://team-***.atlassian.net/rest/api/2/issue/***",
                    "fields": {
                        "summary": "create a bug issue v3 0808f",
                        "status": {
                            "self": "https://team-***.atlassian.net/rest/api/2/status/***",
                            "description": "",
                            "iconUrl": "https://team-***.atlassian.net/",
                            "name": "Backlog",
                            "id": "***",
                            "statusCategory": {
                                "self": "https://team-***.atlassian.net/rest/api/2/statuscategory/2",
                                "id": 2,
                                "key": "new",
                                "colorName": "blue-gray",
                                "name": "To Do"
                            }
                        },
                        "priority": {
                            "self": "https://team-***.atlassian.net/rest/api/2/priority/3",
                            "iconUrl": "https://team-***.atlassian.net/images/icons/priorities/medium.svg",
                            "name": "Medium",
                            "id": "3"
                        },
                        "issuetype": {
                            "self": "https://team-***.atlassian.net/rest/api/2/issuetype/&**",
                            "id": "***",
                            "description": "A problem or error.",
                            "iconUrl": "https://team-***.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/***?size=medium",
                            "name": "Bug",
                            "subtask": false,
                            "avatarId": ***,
                            "hierarchyLevel": 0
                        }
                    }
                }
            }
        ]
    }
}
Context Data

The data extracted from Raw Data converted into JSON format. Context Data may be identical to Raw Data in some cases.

D3 customizes the Context data by extarcting $.issuelinks from the returned raw data.

It is recommended to refer to the Raw Data instead of Context Data, since it contains the complete API response data. D3 will deprecate Context Data in the future, and playbook tasks using Context Data will be replaced with Raw Data.

SAMPLE DATA

CODE
[
    {
        "id": "***",
        "self": "https://team-***.atlassian.net/rest/api/2/issueLink/***",
        "type": {
            "id": "***",
            "name": "Blocks",
            "inward": "is blocked by",
            "outward": "blocks",
            "self": "https://team-***.atlassian.net/rest/api/2/issueLinkType/***"
        },
        "outwardIssue": {
            "id": "***",
            "key": "***",
            "self": "https://team-***.atlassian.net/rest/api/2/issue/***",
            "fields": {
                "summary": "Issue change 808b v2",
                "status": {
                    "self": "https://team-***.atlassian.net/rest/api/2/status/***",
                    "description": "",
                    "iconUrl": "https://team-****.atlassian.net/",
                    "name": "Backlog",
                    "id": "10022",
                    "statusCategory": {
                        "self": "https://team-***.atlassian.net/rest/api/2/statuscategory/2",
                        "id": 2,
                        "key": "new",
                        "colorName": "blue-gray",
                        "name": "To Do"
                    }
                },
                "priority": {
                    "self": "https://team-***.atlassian.net/rest/api/2/priority/3",
                    "iconUrl": "https://team-***.atlassian.net/images/icons/priorities/medium.svg",
                    "name": "Medium",
                    "id": "3"
                },
                "issuetype": {
                    "self": "https://team-***.atlassian.net/rest/api/2/issuetype/***",
                    "id": "***",
                    "description": "The sub-task of the issue",
                    "iconUrl": "https://team-***.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/***?size=medium",
                    "name": "Sub-task",
                    "subtask": true,
                    "avatarId": ***,
                    "hierarchyLevel": -1
                }
            }
        }
    },
    {
        "id": "***",
        "self": "https://team-***.atlassian.net/rest/api/2/issueLink/***",
        "type": {
            "id": "***",
            "name": "Duplicate",
            "inward": "is duplicated by",
            "outward": "duplicates",
            "self": "https://team-***.atlassian.net/rest/api/2/issueLinkType/***"
        },
        "inwardIssue": {
            "id": "***",
            "key": "***",
            "self": "https://team-***.atlassian.net/rest/api/2/issue/***",
            "fields": {
                "summary": "create a bug issue v3 0808f",
                "status": {
                    "self": "https://team-***.atlassian.net/rest/api/2/status/***",
                    "description": "",
                    "iconUrl": "https://team-***.atlassian.net/",
                    "name": "Backlog",
                    "id": "***",
                    "statusCategory": {
                        "self": "https://team-***.atlassian.net/rest/api/2/statuscategory/2",
                        "id": 2,
                        "key": "new",
                        "colorName": "blue-gray",
                        "name": "To Do"
                    }
                },
                "priority": {
                    "self": "https://team-***.atlassian.net/rest/api/2/priority/3",
                    "iconUrl": "https://team-***.atlassian.net/images/icons/priorities/medium.svg",
                    "name": "Medium",
                    "id": "3"
                },
                "issuetype": {
                    "self": "https://team-***.atlassian.net/rest/api/2/issuetype/&**",
                    "id": "***",
                    "description": "A problem or error.",
                    "iconUrl": "https://team-***.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/***?size=medium",
                    "name": "Bug",
                    "subtask": false,
                    "avatarId": ***,
                    "hierarchyLevel": 0
                }
            }
        }
    }
]
Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., will be extracted from Raw Data as Key Fields.
The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.

SAMPLE DATA

CODE
{
    "LinkIds": [
        "***"
    ],
    "LinkTypeIds": [
        "***"
    ],
    "LinkTypeNames": [
        "Blocks"
    ],
    "LinkTypeInwards": [
        "is blocked by"
    ],
    "LinkTypeOutwards": [
        "blocks"
    ],
    "InwardIssueKeys": [
        "***"
    ],
    "OutwardIssueKeys": [
        "***"
    ]
}
Return Data

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

The Partially Successful state only occurs when a command's input accepts an array of items (e.g. an array of IP addresses) and one or more items within the array return an error from the API request.

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

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE
Successful
Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

ID

SELF

TYPE

OUTWARDISSUE

INWARDISSUE


https://team-***.atlassian.net/rest/api/2/issueLink/***

{'id': '***', 'name': 'Blocks', 'inward': 'is blocked by', 'outward': 'blocks', 'self': 'https://team-***.atlassian.net/rest/api/2/issueLinkType/***'}

{'id': '***', 'key': '***', 'self': 'https://team-***.atlassian.net/rest/api/2/issue/***', 'fields': {'summary': 'Issue change 808b v2', 'status': {'self': 'https://team-***.atlassian.net/rest/api/2/status/***', 'description': '', 'iconUrl': 'https://team-***.atlassian.net/', 'name': 'Backlog', 'id': '10022', 'statusCategory': {'self': 'https://team-***.atlassian.net/rest/api/2/statuscategory/2', 'id': 2, 'key': 'new', 'colorName': 'blue-gray', 'name': 'To Do'}}, 'priority': {'self': 'https://team-***.atlassian.net/rest/api/2/priority/3', 'iconUrl': 'https://team-***.atlassian.net/images/icons/priorities/medium.svg', 'name': 'Medium', 'id': '3'}, 'issuetype': {'self': 'https://team-***.atlassian.net/rest/api/2/issuetype/***', 'id': '***', 'description': 'The sub-task of the issue', 'iconUrl': 'https://team-***.atlassian.net/rest/api/2/universal_avatar/view/type/issuetype/avatar/***?size=medium', 'name': 'Sub-task', 'subtask': True, 'avatarId': ***, 'hierarchyLevel': -1}}}

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 you 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

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON
[
    {
        "id": "customfield_***",
        "key": "customfield_***",
        "name": "New Notes",
        "untranslatedName": "New Notes",
        "custom": true,
        "orderable": true,
        "navigable": true,
        "searchable": true,
        "clauseNames": [
            "cf[***]",
            "New Notes",
            "New Notes[Short text]"
        ],
        "schema": {
            "type": "string",
            "custom": "com.atlassian.jira.plugin.system.customfieldtypes:textfield",
            "customId": ***
        }
    },
    {
        "id": "priority",
        "key": "priority",
        "name": "Priority",
        "custom": false,
        "orderable": true,
        "navigable": true,
        "searchable": true,
        "clauseNames": [
            "priority"
        ],
        "schema": {
            "type": "priority",
            "system": "priority"
        }
    }
]
Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., will be extracted from Raw Data as Key Fields.
The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.

SAMPLE DATA

CODE
{
    "FieldIds": [
        "customfield_***",
        "priority"
    ],
    "FieldKeys": [
        "customfield_***",
        "priority"
    ],
    "FieldNames": [
        "New Notes",
        "Priority"
    ],
    "FieldSchemaTypes": [
        "string",
        "priority"
    ]
}
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

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE
Successful
Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

ID

KEY

NAME

UNTRANSLATEDNAME

CUSTOM

ORDERABLE

NAVIGABLE

SEARCHABLE

CLAUSENAMES

SCHEMA

customfield_***

customfield_***

New Notes

New Notes

True

True

True

True

['cf[***]', 'New Notes', 'New Notes[Short text]']

{'type': 'string', 'custom': 'com.atlassian.jira.plugin.system.customfieldtypes:textfield', 'customId': ***}

priority

priority

Priority

False

True

True

True

['priority']

{'type': 'priority', 'system': 'priority'}

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 you 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

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON
{
    "self": "https://api.atlassian.com/ex/jira/***-**-***-***-***/rest/api/2/project/search?maxResults=50&startAt=0",
    "maxResults": 50,
    "startAt": 0,
    "total": 4,
    "isLast": true,
    "values": [
        {
            "expand": "description,lead,issueTypes,url,projectKeys,permissions,insight",
            "self": "https://api.atlassian.com/ex/jira/***-**-***-***-***/rest/api/2/project/***",
            "id": "***",
            "key": "IP",
            "name": "ITSM project-A",
            "avatarUrls": {
                "48x48": "https://api.atlassian.com/ex/jira/***-**-***-***-***/rest/api/2/universal_avatar/view/type/project/avatar/***",
                "24x24": "https://api.atlassian.com/ex/jira/***-**-***-***-***/rest/api/2/universal_avatar/view/type/project/avatar/***?size=small",
                "16x16": "https://api.atlassian.com/ex/jira/***-**-***-***-***/rest/api/2/universal_avatar/view/type/project/avatar/***?size=xsmall",
                "32x32": "https://api.atlassian.com/ex/jira/***-**-***-***-***/rest/api/2/universal_avatar/view/type/project/avatar/***?size=medium"
            },
            "projectTypeKey": "service_desk",
            "simplified": false,
            "style": "classic",
            "isPrivate": true,
            "properties": {}
        },
        {
            "expand": "description,lead,issueTypes,url,projectKeys,permissions,insight",
            "self": "https://api.atlassian.com/ex/jira/***-**-***-***-***/rest/api/2/project/***",
            "id": "***",
            "key": "ITSAMPLE",
            "name": "ITSM sample space",
            "avatarUrls": {
                "48x48": "https://api.atlassian.com/ex/jira/***-**-***-***-***/rest/api/2/universal_avatar/view/type/project/avatar/***",
                "24x24": "https://api.atlassian.com/ex/jira/***-**-***-***-***/rest/api/2/universal_avatar/view/type/project/avatar/***?size=small",
                "16x16": "https://api.atlassian.com/ex/jira/***-**-***-***-***/rest/api/2/universal_avatar/view/type/project/avatar/***?size=xsmall",
                "32x32": "https://api.atlassian.com/ex/jira/***-**-***-***-***/rest/api/2/universal_avatar/view/type/project/avatar/***?size=medium"
            },
            "projectTypeKey": "service_desk",
            "simplified": false,
            "style": "classic",
            "isPrivate": false,
            "properties": {}
        },
        {
            "expand": "description,lead,issueTypes,url,projectKeys,permissions,insight",
            "self": "https://api.atlassian.com/ex/jira/***-**-***-***-***/rest/api/2/project/***",
            "id": "***",
            "key": "LOCAL",
            "name": "testProject",
            "avatarUrls": {
                "48x48": "https://api.atlassian.com/ex/jira/***-**-***-***-***/rest/api/2/universal_avatar/view/type/project/avatar/***",
                "24x24": "https://api.atlassian.com/ex/jira/***-**-***-***-***/rest/api/2/universal_avatar/view/type/project/avatar/***?size=small",
                "16x16": "https://api.atlassian.com/ex/jira/***-**-***-***-***/rest/api/2/universal_avatar/view/type/project/avatar/***?size=xsmall",
                "32x32": "https://api.atlassian.com/ex/jira/***-**-***-***-***/rest/api/2/universal_avatar/view/type/project/avatar/***?size=medium"
            },
            "projectTypeKey": "software",
            "simplified": false,
            "style": "classic",
            "isPrivate": false,
            "properties": {}
            "entityId": "***-**-***-***-***",
            "uuid": "***-**-***-***-***"
        }
    ]
}
Context Data

The data extracted from Raw Data converted into JSON format. Context Data may be identical to Raw Data in some cases.

D3 customizes the Context Data by extracting the data from path $.values in API returned JSON.

It is recommended to refer to the Raw Data instead of Context Data, since it contains the complete API response data. D3 will deprecate Context Data in the future, and playbook tasks using Context Data will be replaced with Raw Data.

SAMPLE DATA

CODE
[
    {
        "expand": "description,lead,issueTypes,url,projectKeys,permissions,insight",
        "self": "https://api.atlassian.com/ex/jira/***-**-***-***-***/rest/api/2/project/***",
        "id": "***",
        "key": "IP",
        "name": "ITSM project-A",
        "avatarUrls": {
            "48x48": "https://api.atlassian.com/ex/jira/***-**-***-***-***/rest/api/2/universal_avatar/view/type/project/avatar/***",
            "24x24": "https://api.atlassian.com/ex/jira/***-**-***-***-***/rest/api/2/universal_avatar/view/type/project/avatar/***?size=small",
            "16x16": "https://api.atlassian.com/ex/jira/***-**-***-***-***/rest/api/2/universal_avatar/view/type/project/avatar/***?size=xsmall",
            "32x32": "https://api.atlassian.com/ex/jira/***-**-***-***-***/rest/api/2/universal_avatar/view/type/project/avatar/***?size=medium"
        },
        "projectTypeKey": "service_desk",
        "simplified": false,
        "style": "classic",
        "isPrivate": true,
        "properties": {}
    },
    {
        "expand": "description,lead,issueTypes,url,projectKeys,permissions,insight",
        "self": "https://api.atlassian.com/ex/jira/***-**-***-***-***/rest/api/2/project/***",
        "id": "***",
        "key": "ITSAMPLE",
        "name": "ITSM sample space",
        "avatarUrls": {
            "48x48": "https://api.atlassian.com/ex/jira/***-**-***-***-***/rest/api/2/universal_avatar/view/type/project/avatar/***",
            "24x24": "https://api.atlassian.com/ex/jira/***-**-***-***-***/rest/api/2/universal_avatar/view/type/project/avatar/***?size=small",
            "16x16": "https://api.atlassian.com/ex/jira/***-**-***-***-***/rest/api/2/universal_avatar/view/type/project/avatar/***?size=xsmall",
            "32x32": "https://api.atlassian.com/ex/jira/***-**-***-***-***/rest/api/2/universal_avatar/view/type/project/avatar/***?size=medium"
        },
        "projectTypeKey": "service_desk",
        "simplified": false,
        "style": "classic",
        "isPrivate": false,
        "properties": {}
    },
    {
        "expand": "description,lead,issueTypes,url,projectKeys,permissions,insight",
        "self": "https://api.atlassian.com/ex/jira/***-**-***-***-***/rest/api/2/project/***",
        "id": "***",
        "key": "LOCAL",
        "name": "testProject",
        "avatarUrls": {
            "48x48": "https://api.atlassian.com/ex/jira/***-**-***-***-***/rest/api/2/universal_avatar/view/type/project/avatar/***",
            "24x24": "https://api.atlassian.com/ex/jira/***-**-***-***-***/rest/api/2/universal_avatar/view/type/project/avatar/***?size=small",
            "16x16": "https://api.atlassian.com/ex/jira/***-**-***-***-***/rest/api/2/universal_avatar/view/type/project/avatar/***?size=xsmall",
            "32x32": "https://api.atlassian.com/ex/jira/***-**-***-***-***/rest/api/2/universal_avatar/view/type/project/avatar/***?size=medium"
        },
        "projectTypeKey": "software",
        "simplified": false,
        "style": "classic",
        "isPrivate": false,
        "properties": {}
        "entityId": "***-**-***-***-***",
        "uuid": "***-**-***-***-***"
    }
]
Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., will be extracted from Raw Data as Key Fields.
The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.

SAMPLE DATA

CODE
{
    "ProjectIds": [
        "***",
        "**",
        "**",
        "***"
    ],
    "ProjectKeys": [
        "IP",
        "ITSAMPLE",
        "LOCAL",
        "MAINPRO"
    ],
    "ProjectNames": [
        "ITSM project-A",
        "ITSM sample space",
        "testProject",
        "20220804-Test"
    ],
    "ProjectTypes": [
        "service_desk",
        "service_desk",
        "software",
        "software"
    ]
}
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

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE
Successful
Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

EXPAND

SELF

ID

KEY

NAME

AVATARURLS

PROJECTTYPEKEY

SIMPLIFIED

STYLE

ISPRIVATE

PROPERTIES

ENTITYID

UUID

description,lead,issueTypes,url,projectKeys,permissions,insight

https://api.atlassian.com/ex/jira/***-**-***-***-***/rest/api/2/project/***


IP

ITSM project-A

{'48x48': 'https://api.atlassian.com/ex/jira/***-**-***-***-***/rest/api/2/universal_avatar/view/type/project/avatar/***', '24x24': 'https://api.atlassian.com/ex/jira/***-**-***-***-***/api/2/universal_avatar/view/type/project/avatar/**?size=small', '16x16': 'https://api.atlassian.com/ex/jira/***-**-***-***-***/rest/api/2/universal_avatar/view/type/project/avatar/***?size=xsmall', '32x32': 'https://api.atlassian.com/ex/jira/***-**-***-***-***/rest/api/2/universal_avatar/view/type/project/avatar/***?size=medium'}

service_desk

False

classic

True

{}

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 you 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.

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

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON
No Sample Data
Context Data

The data extracted from Raw Data converted into JSON format. Context Data may be identical to Raw Data in some cases.

D3 customizes the Context Data by extracting the data from path $.issues[*].fields in API returned JSON.

It is recommended to refer to the Raw Data instead of Context Data, since it contains the complete API response data. D3 will deprecate Context Data in the future, and playbook tasks using Context Data will be replaced with Raw Data.

SAMPLE DATA

CODE
No Sample Data
Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., will be extracted from Raw Data as Key Fields.
The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.

SAMPLE DATA

CODE
{
    "IssueIds": [
        "***"
    ],
    "IssueKeys": [
        "***"
    ],
    "CreatedTime": [
        "2022-08-08T22:08:00.731+0000"
    ],
    "UpdatedTime": [
        "2022-08-09T20:44:17.278+0000"
    ],
    "AssigneeDisplayNames": [
        "*** d3lab"
    ],
    "Statuses": [
        "Backlog"
    ]
}
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

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE
Successful
Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

CODE
No Sample Data

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 you 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 is not currently compatible with the version 3 of Jira's API. It is recommended to build a separate connection with API version 2 to use this command.

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

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

    • Run the List Transitions command to obtain Transition Name. Transition Name can be found in the returned raw data at the path $.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.

[ "***" ]

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.

{

"assignee": {

"name": "bob"

},

"resolution": {

"name": "Fixed"

}

}

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON
[
    {
        "expand": "renderedFields,names,schema,operations,editmeta,changelog,versionedRepresentations",
        "id": "***",
        "self": "https://api.atlassian.com/ex/jira/***-**-***-***-***/rest/api/3/issue/***",
        "key": "***",
        "fields": {
            "status": {
                "self": "https://api.atlassian.com/ex/jira/***-**-***-***-***/rest/api/3/status/3",
                "description": "This issue is being actively worked on at the moment by the assignee.",
                "iconUrl": "https://team-***.atlassian.net/images/icons/statuses/inprogress.png",
                "name": "In Progress",
                "id": "3",
                "statusCategory": {
                    "self": "https://api.atlassian.com/ex/jira/***-**-***-***-***/rest/api/3/statuscategory/4",
                    "id": 4,
                    "key": "indeterminate",
                    "colorName": "yellow",
                    "name": "In Progress"
                }
            }
        }
    }
]
Context Data

The data extracted from Raw Data converted into JSON format. Context Data may be identical to Raw Data in some cases.

It is recommended to refer to the Raw Data instead of Context Data, since it contains the complete API response data. D3 will deprecate Context Data in the future, and playbook tasks using Context Data will be replaced with Raw Data.

SAMPLE DATA

CODE
No Sample Data
Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., will be extracted from Raw Data as Key Fields.
The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.

SAMPLE DATA

CODE
{
    "IssueKeys": [
        "***"
    ],
    "IssueIds": [
        "***"
    ],
    "issueStatuses": [
        "In Progress"
    ]
}
Return Data

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

The Partially Successful state only occurs when a command's input accepts an array of items (e.g. an array of IP addresses) and one or more items within the array return an error from the API request.

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

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE
Successful
Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

EXPAND

ID

SELF

KEY

FIELDS

renderedFields,names,schema,operations,editmeta,changelog,versionedRepresentations


https://api.atlassian.com/ex/jira/***-**-***-***-***/rest/api/3/issue/***


{'status': {'self': 'https://api.atlassian.com/ex/jira/***-**-***-***-***/rest/api/3/status/3', 'description': 'This issue is being actively worked on at the moment by the assignee.', 'iconUrl': 'https://team-***.atlassian.net/images/icons/statuses/inprogress.png', 'name': 'In Progress', 'id': '3', 'statusCategory': {'self': 'https://api.atlassian.com/ex/jira/***-**-***-***-***a/rest/api/3/statuscategory/4', 'id': 4, 'key': 'indeterminate', 'colorName': 'yellow', 'name': 'In Progress'}}}

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 you 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

Input parameter Link IDs is required to run this command.

  • Run the Get Issue Links command to obtain Link IDs. Link IDs can be found in the returned raw data at the path $.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.

[ "***" ]

Output

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON
{
    "***": {
        "status": "Successful"
    }
}
Context Data

The data extracted from Raw Data converted into JSON format. Context Data may be identical to Raw Data in some cases.

It is recommended to refer to the Raw Data instead of Context Data, since it contains the complete API response data. D3 will deprecate Context Data in the future, and playbook tasks using Context Data will be replaced with Raw Data.

SAMPLE DATA

CODE
No Sample Data
Return Data

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

The Partially Successful state only occurs when a command's input accepts an array of items (e.g. an array of IP addresses) and one or more items within the array return an error from the API request.

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

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE
Successful
Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

10015

{'status': 'Successful'}

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 you 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 Issue Keys. Issue Key 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".

It is not recommended to use the Test Command feature with the Submit Sample Files 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:

  1. In D3 SOAR, navigate to Configuration on the top bar menu.

  2. Click Utility Commands on the left sidebar menu.

  3. Use the search box to find and select the Create a File from input Text Array command.

  4. Select the Test tab, then input the required information for the parameters. Click Test Command.
    A D3 File ID will appear in the output data after the file has been successfully created.
    (Note: 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.

[ "750", "751" ]

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

Raw Data

The primary response data from the API request.

SAMPLE DATA

JSON
[
    {
        "self": "https://team-***.atlassian.net/rest/api/3/attachment/10004",
        "id": "***",
        "filename": "blueJay.png",
        "author": {
            "self": "https://team-***.atlassian.net/rest/api/3/user?accountId=***",
            "accountId": "***",
            "emailAddress": "test@example.com",
            "avatarUrls": {
                "48x48": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png",
                "24x24": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png",
                "16x16": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png",
                "32x32": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png"
            },
            "displayName": "D3 System Engineer Team",
            "active": true,
            "timeZone": "CET",
            "accountType": "atlassian"
        },
        "created": "2022-08-09T23:24:55.974+0000",
        "size": 4290,
        "mimeType": "image/png",
        "content": "https://team-***.atlassian.net/rest/api/3/attachment/content/***",
        "thumbnail": "https://team-***.atlassian.net/rest/api/3/attachment/thumbnail/***"
    },
    {
        "self": "https://team-***.atlassian.net/rest/api/3/attachment/***",
        "id": "***",
        "filename": "lakeLouise.jpg",
        "author": {
            "self": "https://team-***.atlassian.net/rest/api/3/user?accountId=***",
            "accountId": "***",
            "emailAddress": "test@example.com",
            "avatarUrls": {
                "48x48": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png",
                "24x24": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png",
                "16x16": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png",
                "32x32": "https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png"
            },
            "displayName": "D3 System Engineer Team",
            "active": true,
            "timeZone": "CET",
            "accountType": "atlassian"
        },
        "created": "2022-08-09T23:24:56.200+0000",
        "size": 98305,
        "mimeType": "image/jpeg",
        "content": "https://team-***.atlassian.net/rest/api/3/attachment/content/***",
        "thumbnail": "https://team-***.atlassian.net/rest/api/3/attachment/thumbnail/***"
    }
]
Context Data

The data extracted from Raw Data converted into JSON format. Context Data may be identical to Raw Data in some cases.

It is recommended to refer to the Raw Data instead of Context Data, since it contains the complete API response data. D3 will deprecate Context Data in the future, and playbook tasks using Context Data will be replaced with Raw Data.

SAMPLE DATA

CODE
No Sample Data
Key Fields

Common cyber security indicators such as unique IDs, file hash values, CVE numbers, IP addresses, etc., will be extracted from Raw Data as Key Fields.
The system stores these key fields in the path $.[playbookTask].outputData. You can use these key-value pairs as data points for playbook task inputs.

SAMPLE DATA

CODE
{
    "AttachmentIds": [
        "***",
        "***"
    ],
    "fileNames": [
        "blueJay.png",
        "lakeLouise.jpg"
    ]
}
Return Data

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

The Partially Successful state only occurs when a command's input accepts an array of items (e.g. an array of IP addresses) and one or more items within the array return an error from the API request.

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

You can view more details about an error in the Error tab.

Return Data can be passed down directly to a subsequent command or used to create conditional tasks in playbooks.

SAMPLE DATA

CODE
Successful
Result

Provides a brief summary of outputs in an HTML formatted table.

SAMPLE DATA

SELF

ID

FILENAME

AUTHOR

CREATED

SIZE

MIMETYPE

CONTENT

THUMBNAIL

https://team-***.atlassian.net/rest/api/3/attachment/***


blueJay.png

{'self': 'https://team-***.atlassian.net/rest/api/3/user?accountId=***', 'accountId': '***', 'emailAddress': 'test@example.com', 'avatarUrls': {'48x48': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png', '24x24': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png', '16x16': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png', '32x32': 'https://secure.gravatar.com/avatar/***?d=https%3A%2F%2Favatar-management--avatars.us-west-2.prod.public.atl-paas.net%2Finitials%2FDT-6.png'}, 'displayName': 'D3 System Engineer Team', 'active': True, 'timeZone': 'CET', 'accountType': 'atlassian'}

2022-08-09T23:24:55.974+0000

4290

image/png

https://team-***.atlassian.net/rest/api/3/attachment/content/***

https://team-***.atlassian.net/rest/api/3/attachment/thumbnail/***

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 you 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 you to perform a health check on an integration connection. You can schedule a periodic health check by selecting Connection Health Check when editing an integration connection.

Input

N/A

Output

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

You can view more details about an error in the Error tab.

SAMPLE DATA

CODE
Successful

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 you 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 Jira to request a new refresh token.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.