Skip to main content
Skip table of contents

Get Linked Incidents Of An Incident

READER NOTE

If you are not currently using version 16.9, you may encounter limitations in accessing this command. Kindly reach out to D3 for assistance in obtaining access if such a situation arises.

This command is specifically designed to recursively retrieve all incidents associated with the current incident, including those linked to subsequent incidents. The maximum recursive depth has been set at a value of 10. The result will include the initial incident.

Implementation

Python

Command Category

System Utility

Tags

N/A

Inputs

Parameter Name

Required/Optional

Description

Sample Data

Incident Number

Required

The incident number for which the linked incidents will be retrieved.

20211015-2

Output

Return Data

The returned result of this command. If some required parameters are not defined, this returned data could be empty. The returned result can be passed down directly to a subsequent command in playbooks.

SAMPLE DATA

JSON
{
    "Status": "Successful",
    "Data": [
        "20211015-2",
        "20211015-3",
        "20211027-4",
        "20211027-8",
        "20211027-9",
        "20230914-3"
    ]
}

Remote Command API

The D3 command API allows you to send requests to D3 SOAR to execute this utility command via REST API.

Request

POST

CODE
https://{base_url}/{api_namespace}/api/Command/GetLinkedIncidentsOfAnIncident

Headers

Please refer to the page Webhook Configuration Guide - Authentication Method: API Keys for more details.

Request Body

JSON
{
  "Username": <Username here>,
  "Site": <Site here>,
  "CommandParams": {
    "Incident Number": <Incident Number here>
  }
}

Body Parameters

Parameter Name

Type

Required/Optional

Description

Username

String

Required

The username of your D3 SOAR account.

Site

String

Required

The D3 SOAR site to run the remote command.

Incident Number

Text

Required

The incident number for which the linked incidents will be retrieved.

Sample Request

SAMPLE DATA

JSON
{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
  "Incident Number": "20211015-2"
  }
}

Response

Response Fields

Field Name

Type

Description

error

String

The error message if the API request has failed.

returnData

JSON Object

The return data from the API request.

Sample Response

JSON
{
    "error": "",
    "returnData": {
    "Status": "Successful",
    "Data": [
        "20211015-2",
        "20211015-3",
        "20211027-4",
        "20211027-8",
        "20211027-9",
        "20230914-3"
    ]
}
}
JavaScript errors detected

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

If this problem persists, please contact our support.