Set Incident Field

Set the incident field to a specific value. Please note that the 'Title' field cannot exceed 100 characters. If it exceeds the limit, any extra characters will be truncated.

Implementation	System
Command Category	System Utility
Tags	INCIDENT INCIDENT FIELDS

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Incident Number	Optional	The incident number to set the fields to.	`20200527-244`
Field Name	Optional	The name of an incident field.	`Title`
Field Value	Optional	The value to be set to the specified incident field. DateFormat: 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	`Text`	Optional	The incident number to set the fields to.
Field Name	`Text`	Optional	The name of an incident field.
Field Value	`Text`	Optional	The value to be set to the specified incident field. DateFormat: 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	`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": "",
    "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"
    }
}