Set Incident Notes

LAST UPDATED: AUG 27, 2024

Adds the specified list of notes to notes of the current incident.

READER NOTE

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"
}