Set Incident Field HTML | docs.d3security

Last updated: Aug 29, 2024

Replaces the content within the description, note, or conclusion section of an incident with an HTML string.

Implementation	System
Command Category	System Utility
Tags	Incident Incident fields

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Incident Number	Required	The unique identifier of the incident to be updated.	20230405-12
Field Name	Required	The incident field to be set. The options are: Note Description Conclusion	Note
HTML Content	Required	The content provided in an HTML string.	`<table class="cc-table horizontal-table"> <tr> <td>192.168.1.242</td> <td>Low</td> </tr> <tr> <td>192.168.1.243</td> <td>High</td> </tr> </table>`

Parameter Name

Required/Optional

Description

Sample Data

Incident Number

Required

The unique identifier of the incident to be updated.

20230405-12

Field Name

Required

The incident field to be set. The options are:

Note
Description
Conclusion

Note

HTML Content

Required

The content provided in an HTML string.

<table class="cc-table horizontal-table">
    <tr>
        <td>192.168.1.242</td>
        <td>Low</td>
    </tr>
    <tr>
        <td>192.168.1.243</td>
        <td>High</td>
    </tr>
</table>

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

{
    "IncidentNumber": "TEST-INCIDENT-51",
    "ModifiedDate": "6/17/2021 1:30:35 PM",
    "Notes": "Test incident notes",
    "Result": "Succeed",
    "ModifiedBy": "D3 admin"
}

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

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 Number": "<Incident Number here>",
    "Field Name": "<Field Name here>",
    "HTML Content": "<HTML Content 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 Number	`string`	Required	The unique identifier of the incident to be updated.
Field Name	`string`	Required	The incident field to be set. The options are: Note Description Conclusion
HTML Content	`string`	Required	The content provided in an HTML string.

Sample Request

Sample Data

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Incident Number": "20230405-12",
    "Field Name": "Note",
    "HTML Content": "
      192.168.1.242	Low
      192.168.1.243	High
      "
  }
}

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

Sample Response

JSON

{
    "error": "",
    "returnData": "Successful",
    "contextData": {
        "IncidentNumber": "TEST-INCIDENT-51",
        "ModifiedDate": "6/17/2021 1:30:35 PM",
        "Notes": "Test incident notes",
        "Result": "Succeed",
        "ModifiedBy": "D3 admin"
    }
}