Link Incident to Existing Cases‎

POST /Command/LinkIncidentToExistingCases

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

Request

Authentication: API keys or JSON web tokens (JWT)

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>`	Optional	The array of case numbers of existing cases that will be linked to the incident.
Username	`string`	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	`array<string>`	Optional	The array of incident numbers can be linked.

Body Sample Data

application/json

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

Response

200 OK

application/json

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

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

401 Unauthorized

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

{"Error": "Invalid authentication key."}

429 TooManyRequests

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

{"Error": "The request exceeds rate limits or is otherwise blocked by rate limiting policies."}

500 InternalServerError

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

{"Error": "Unexpected Error."}