Set Incident Notes HTML
Adds a note in HTML format to notes of the current incident.
Reader Note
Please note that this command is only applicable within an incident Playbook.
Implementation | System |
Command Category | System Utility |
Tags | INCIDENT INCIDENT NOTES |
Inputs
Parameter Name | Required/Optional | Description | Sample Data |
---|---|---|---|
HTML Note | Optional | A note in HTML String. |
|
Output
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/SetIncidentNoteHTML
Headers
Please refer to the page Webhook Configuration Guide - Authentication Method: API Keys for more details.
Request Body
{
"Username": "<Username here>",
"Site": "<Site here>",
"CommandParams": {
"HTML Note": "<HTML Note here>"
}
}
Body Parameters
Parameter Name | Type | Required/Optional | Description |
---|---|---|---|
Username |
| Required | The username of your D3 SOAR account. |
Site |
| Required | The D3 SOAR site to run the remote command. |
HTML Note |
| Optional | A note in HTML String. |
Sample Request
SAMPLE DATA
{
"Username": "Admin",
"Site": "Security Operations",
"CommandParams": {
"HTML Note": "
192.168.1.242 Low
192.168.1.243 High
"
}
}
Response
Response Fields
Field Name | Type | Description |
---|---|---|
error |
| The error message if the API request has failed. |
returnData |
| The return data from the API request. |
contextData |
| The context data from the API request. |
Sample Response
{
"error": "",
"returnData": "Successful",
"rawData": "",
"contextData": {
"IncidentNumber": "TEST-INCIDENT-51",
"ModifiedDate": "6/17/2021 1:30:35 PM",
"Notes": "Test incident notes",
"Result": "Succeed",
"ModifiedBy": "D3 admin"
}
}