Link Incident to Existing Cases

Link the current incident to existing cases provided by a case number array.

Implementation	System
Command Category	System Utility
Tags	INCIDENT INCIDENT LINKING

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Case Numbers	Optional	The array of case numbers of existing cases that will be linked to the incident.	CODE `[ "20210127-198", "20210127-197" ]`
Username	Optional	The username of user that link incident to cases. This username will be used only when the task is run automatically.	`admin user`
Incident ID List	Optional	The array of incident numbers can be linked.	CODE `[ "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

CODE

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	`Text Array`	Optional	The array of case numbers of existing cases that will be linked to the incident.
Username	`Text`	Optional	The username of user that link incident to cases. This username will be used only when the task is run automatically.
Incident ID List	`Text Array`	Optional	The array of incident numbers can be linked.

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	`Text`	The return data from the API request.

Sample Response

JSON

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