Link Incident to Existing Cases

Last updated: Sept 04, 2024

Adds incidents to cases.

Implementation	System
Command Category	System Utility
Tags	Incident Incident Linking

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Case Numbers	Required	The array of case numbers corresponding to the cases to which the incidents will be linked.	`[ "20210127-198", "20210127-197" ]`
Username	Optional	The username of the user who is linking the incidents to cases. This username will be used only when the task is run automatically.	admin user
Incident ID List	Required	The array of incident numbers that specifies which incidents will be linked to the cases.	`[ "20200118-2650" ]`

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

Successful

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

https:/{base_url}/{api_namespace}/api/Command/LinkIncidentToExistingCases

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": {
    "Case Numbers": "<Case Numbers here>",
    "Username": "<Username here>",
    "Incident ID List": "<Incident ID List 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.
Case Numbers	`array<string>`	Required	The array of case numbers corresponding to the cases to which the incidents will be linked.
Username	`string`	Optional	The username of the user who is linking the incidents to cases. This username will be used only when the task is run automatically.
Incident ID List	`array<string>`	Required	The array of incident numbers that specifies which incidents will be linked to the cases.

Sample Request

Sample Data

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Case Numbers": [
      "20210127-198",
      "20210127-197"
    ],
    "Username": "admin user",
    "Incident ID List": [
      "20200118-2650"
    ]
  }
}

Response

Response Fields

Field Name	Type	Description
error	`string`	The error message if the API request has failed.
returnData	`string`	The return data from the API request.

Sample Response

JSON

{
    "error": "",
    "returnData": "Successful"
}