Update Incidents' Site in Bulk

LAST UPDATED: AUG 02, 2024

Updates the sites of multiple incidents based on the provided incident numbers and site name.

Implementation	System
Command Category	System Utility
Tags	INCIDENT INCIDENT FIELDS

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Incident Numbers	Required	The array of incident numbers corresponding to the incidents whose site will be updated.	CODE `[ "20210127-198", "20210127-197" ]`
Site	Required	The name of the new site to be assigned to the incidents.	Security Operations
Username	Optional	The username of user updating the incidents' site. This username will be used only when the task is run automatically.	admin user

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

Context Data

The response data from the utility command.

SAMPLE DATA

JSON

[
    {
        "Incident Number": "20210127-198",
        "Incident Owner": "Security Operations",
        "Result": "Successful"
    },
    {
        "Incident Number": "20210127-197",
        "Incident Owner": "Security Operations",
        "Result": "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/UpdateIncidentSiteInBulk

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 Numbers": "<Incident Numbers here>",
    "Site": "<Site here>",
    "Username": "<Username 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 Numbers	`array<string>`	Required	The array of incident numbers corresponding to the incidents whose site will be updated.
Site	`string`	Required	The name of the new site to be assigned to the incidents.
Username	`string`	Optional	The username of user updating the incidents' site. This username will be used only when the task is run automatically.

Sample Request

SAMPLE DATA

JSON

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

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.
contextData	`array<JSON Object>`	The context data from the API request.

Sample Response

JSON

{
    "error": "",
    "returnData": "Successful",
    "contextData": [
        {
            "Incident Number": "20210127-198",
            "Incident Owner": "Security Operations",
            "Result": "Successful"
        },
        {
            "Incident Number": "20210127-197",
            "Incident Owner": "Security Operations",
            "Result": "Successful"
        }
    ]
}