Set Incident Notes

Adds the specified list of notes 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
Notes	Optional	A list of notes to add to the current incident.	CODE `[ "This incident is for analyze artifacts", "This incident is for test" ]`

Output

Key Fields

Important key-value pairs extracted from Raw Data.

SAMPLE DATA

JSON

{
  "IncidentNumber": "20200529-295",
  "ModifiedDate": "5/29/2020 3:49:39 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": "20200529-295",
    "ModifiedDate": "5/29/2020 3:49:39 PM",
    "Notes": [
        "This incident is for analyze artifacts",
        "This incident is for test"
    ],
    "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

CODE

https:/{base_url}/{api_namespace}/api/Command/SetIncidentNotes

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": {
    "Notes": "<Notes 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.
Notes	`Text Array`	Optional	A list of notes to add to the current incident.

Sample Request

SAMPLE DATA

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Notes": [
      "This incident is for analyze artifacts",
      "This incident is for test"
    ]
  }
}

Response

Response Fields

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

Sample Response

JSON

{
    "error": "",
    "returnData": "Succeed",
    "contextData": {
        "IncidentNumber": "20200529-295",
        "ModifiedDate": "5/29/2020 3:49:39 PM",
        "Notes": [
            "This incident is for analyze artifacts",
            "This incident is for test"
        ],
        "Result": "Succeed",
        "ModifiedBy": "admin user"
    }
}