Set Incident Fields
LAST UPDATED: AUG 29, 2024
Updates the selected fields of one incident.
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. | 20110803-1 |
Input | Required | The object that specifies the built-in and custom fields to update for the incident. The built-in incident fields that can be updated are Title, SiteName, IncidentType, Status, SeverityName, Disposition, Tags, DueDate, Description, IncidentCategory, DateEnded, Owner, and DateOccurred. The custom incident fields will be placed under the Custom Fields section in the incident workspace. They will be retitled with "Custom" prefixed and have any spaces or special characters removed. The date format should be in the form: yyyy-MM-dd HH:mm:ss. |
CODE
|
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/SetIncidentFields
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": {
"Incident Number": "<Incident Number here>",
"Input": "<Input 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. |
Incident Number |
| Required | The incident number to set the fields to. |
Input |
| Required | The object that specifies the built-in and custom fields to update for the incident. The built-in incident fields that can be updated are Title, SiteName, IncidentType, Status, SeverityName, Disposition, Tags, DueDate, Description, IncidentCategory, DateEnded, Owner, and DateOccurred. The custom incident fields will be placed under the Custom Fields section in the incident workspace. They will be retitled with "Custom" prefixed and have any spaces or special characters removed. The date format should be in the form: yyyy-MM-dd HH:mm:ss. |
Sample Request
SAMPLE DATA
{
"Username": "Admin",
"Site": "Security Operations",
"CommandParams": {
"Incident Number": "20110803-1",
"Input": {
"Title": "Incident title",
"SiteName": "APSOC",
"IncidentType": "Phishing",
"Status": "Closed",
"SeverityName": "medium",
"Disposition": "No Action",
"Tags": "MyTag, MyTag2",
"Description": "This is for updating incident",
"DueDate": "2021-08-01 12:00:00",
"IncidentCategory": "Access",
"DateEnded": "2021-08-02 12:00:00",
"Owner": "firstname lastname",
"DateOccurred": "2021-08-02 12:00:00",
"CustomAge": "30",
"CustomSpecialField": "some special text"
}
}
}
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",
"contextData": {
"Title": "Incident title",
"SiteName": "APSOC",
"IncidentType": "Phishing",
"Status": "Closed",
"SeverityName": "medium",
"Disposition": "No Action",
"Tags": "MyTag, MyTag2",
"Description": "This is for updating incident",
"DueDate": "2021-08-01 12:00:00",
"IncidentCategory": "Access",
"DateEnded": "2021-08-02 12:00:00",
"Owner": "firstname lastname",
"DateOccurred": "2021-08-02 12:00:00",
"CustomAge": "30",
"CustomSpecialField": "some special text"
}
}