Skip to main content
Skip table of contents

Remove Linked Incidents

LAST UPDATED: AUG 02, 2024

Removes Linked Incident(s) from the Source Incident.

Implementation

System

Command Category

System Utility

Tags

INCIDENT INCIDENT LINKING

Inputs

Parameter Name

Required/Optional

Description

Sample Data

Linked Incident Numbers to be Removed

Required

A list of incident numbers corresponding to existing incidents that will be removed from the source incident.

CODE
[
  "20210127-198",
  "20210127-197"
]

Source Incident Number

Optional

The source incident number from which the incident link is deleted. If left blank, the current incident in the playbook will be used by default.

20231025-130

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": "Partially Successful",
    "Data": {
        "Current linked Incident(s) of Incident 20231025-130 ": [
            "20231025-131"
        ]
    },
    "ErrorData": [
        {
            "Incident Number": "20210127-198",
            "Error message": "The source incident is not linked to this incident."
        }
    ]
}

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/RemoveLinkedIncidents

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": {
    "Linked Incident Numbers to be Removed": "<Linked Incident Numbers to be Removed>",
    "Source Incident Number": "<Source 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.

Linked Incident Numbers to be Removed

array<string>

Required

A list of incident numbers corresponding to existing incidents that will be removed from the source incident.

Source Incident Number

string

Optional

The source incident number from which the incident link is deleted. If left blank, the current incident in the playbook will be used by default.

Sample Request

SAMPLE DATA

JSON
{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Linked Incident Numbers to be Removed": [
      "20210127-198",
      "20210127-197"
    ],
    "Source Incident Number": "20231025-130"
  }
}

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": "Partially Successful",
      "Data": {
          "Current linked Incident(s) of Incident 20231025-130 ": [
              "20231025-131"
          ]
      },
      "ErrorData": [
          {
              "Incident Number": "20210127-198",
              "Error message": "The source incident is not linked to this incident."
          }
      ]
    }
}
JavaScript errors detected

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

If this problem persists, please contact our support.