Update Incident Dynamic Field Values with Event Data

Last updated: Aug 29, 2024

Updates a dynamic field value of an incident with event data.

Implementation	System
Command Category	System Utility
Tags	Incident Incident Dynamic Form

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Event Field Names	Optional	The event field names.	`[ "Severity", "Event name", "Direction", "Device volume", "Source translated IP address" ]`
Dynamic Section Name	Required	The name of a Section item within an incident form.	All Activities 123
Section Field Name	Required	The name of an Info Activity item within an incident form.	Text Area
Incident Number	Required	The incident number associated with the target incident.	20230206-2

Output

Key Fields

Important key-value pairs extracted from Raw Data.

Sample Data

JSON

{
  "IncidentNumber": "20230206-2",
  "ModifiedDate": "2/6/2023 5:39:38 PM",
  "ModifiedBy": "admin user"
}

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

Succeed

Context Data

The response data from the utility command.

Sample Data

JSON

{
    "incidentNumber": "20230206-2",
    "sectionName": "All Activities 123",
    "fieldAndValue": {
        "Text Area": "<table class='cc-table vertical-table'><tr><th>Severity</th><td>[<br>  &quot;60&quot;<br>]</td></tr><tr><th>Event name</th><td>[<br>  &quot;Bitcoin-related domain name queried by EC2 instance i-0406e39fb469745c9.&quot;,<br>  &quot;Task 40117 DT_2961 (D3MainApp.15.3) Details of 100 detections and 10 (later 100+) automation rules&quot;<br>]</td></tr><tr><th>Direction</th><td>[]</td></tr><tr><th>Device volume</th><td>[<br>  &quot;arn:aws:ec2:us-east-2:391501681688:instance/i-0406e39fb469745c9&quot;<br>]</td></tr><tr><th>Source translated IP address</th><td>[<br>  &quot;18.191.205.203, 10.10.0.116&quot;<br>]</td></tr></table>"
    },
    "modifiedDate": "2/6/2023 5:39:38 PM",
    "result": "Succeed",
    "modifiedBy": "admin user"
}

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

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": {
    "Event Field Names": "<Event Field Names here>",
    "Dynamic Section Name": "<Dynamic Section Name here>",
    "Section Field Name": "<Section Field Name here>",
    "Incident Number": "<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.
Event Field Names	`array<string>`	Optional	The event field names.
Dynamic Section Name	`string`	Required	The name of a Section item within an incident form.
Section Field Name	`string`	Required	The name of an Info Activity item within an incident form.
Incident Number	`string`	Required	The incident number associated with the target incident.

Sample Request

Sample Data

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Event Field Names": [
      "Severity",
      "Event name",
      "Direction",
      "Device volume",
      "Source translated IP address"
    ],
    "Dynamic Section Name": "All Activities 123",
    "Section Field Name": "Text Area",
    "Incident Number": "20230206-2"
  }
}

Response

Response Fields

Field Name	Type	Description
error	`string`	The error message if the API request has failed.
keyFields	`JSON Object`	The key fields from the API request.
returnData	`string`	The return data from the API request.
contextData	`JSON Object`	The context data from the API request.

Sample Response

JSON

{
    "error": "",
    "keyFields": {
      "IncidentNumber": "20230206-2",
      "ModifiedDate": "2/6/2023 5:39:38 PM",
      "ModifiedBy": "admin user"
    },
    "returnData": "Succeed",
    "contextData": {
        "incidentNumber": "20230206-2",
        "sectionName": "All Activities 123",
        "fieldAndValue": {
            "Text Area": "<table class='cc-table vertical-table'><tr><th>Severity</th><td>[<br>  &quot;60&quot;<br>]</td></tr><tr><th>Event name</th><td>[<br>  &quot;Bitcoin-related domain name queried by EC2 instance i-0406e39fb469745c9.&quot;,<br>  &quot;Task 40117 DT_2961 (D3MainApp.15.3) Details of 100 detections and 10 (later 100+) automation rules&quot;<br>]</td></tr><tr><th>Direction</th><td>[]</td></tr><tr><th>Device volume</th><td>[<br>  &quot;arn:aws:ec2:us-east-2:391501681688:instance/i-0406e39fb469745c9&quot;<br>]</td></tr><tr><th>Source translated IP address</th><td>[<br>  &quot;18.191.205.203, 10.10.0.116&quot;<br>]</td></tr></table>"
        },
        "modifiedDate": "2/6/2023 5:39:38 PM",
        "result": "Succeed",
        "modifiedBy": "admin user"
    }
}