Set Incident Field

LAST UPDATED: AUG 29, 2024

Sets a specific value for an incident field.

READER NOTE

The Title field cannot exceed 100 characters. If it does, any additional characters will be truncated.

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.

20200527-244

Field Name

Required

The incident field to update. The options are:

Site
Incident Type
Title
Status
Severity
Owner
Due Date
Description
Conclusion
Date Occurred
Date Ended
Priority Status
Disposition
Tags

Title

Field Value

Required

The value to be assigned to the specified incident field.

The date format should be in the form: yyyy-MM-dd HH:mm:ss.

New Incident Title

Output

Key Fields

Important key-value pairs extracted from Raw Data.

SAMPLE DATA

JSON

{
  "IncidentNumber": "20200527-244",
  "FieldName": "title",
  "FieldNewValue": "New Incident Title",
  "ModifiedDate": "5/27/2020 3:00:55 PM",
  "Result": "Succeed",
  "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": "20200527-244",
    "fieldName": "title",
    "fieldNewVlaue": "New Incident Title",
    "modifiedDate": "5/27/2020 3:00:55 PM",
    "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/SetIncidentField

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>",
    "Field Value": "<Field Value 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 update. The options are: Site Incident Type Title Status Severity Owner Due Date Description Conclusion Date Occurred Date Ended Priority Status Disposition Tags
Field Value	`string`	Required	The value to be assigned to the specified incident field. The date format should be in the form: yyyy-MM-dd HH:mm:ss.

Sample Request

SAMPLE DATA

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Incident Number": "20200527-244",
    "Field Name": "Title",
    "Field Value": "New Incident Title"
  }
}

Response

Response Fields

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

Sample Response

JSON

{
    "error": "",
    "keyFields": {
      "IncidentNumber": "20200527-244",
      "FieldName": "title",
      "FieldNewValue": "New Incident Title",
      "ModifiedDate": "5/27/2020 3:00:55 PM",
      "Result": "Succeed",
      "ModifiedBy": "admin user"
    },
    "returnData": "Succeed",
    "contextData": {
        "incidentNumber": "20200527-244",
        "fieldName": "title",
        "fieldNewVlaue": "New Incident Title",
        "modifiedDate": "5/27/2020 3:00:55 PM",
        "result": "Succeed",
        "modifiedBy": "admin user"
    }
}