Modify Incident Form

LAST UPDATED: OCT 29, 2024

Modifies the incident forms by either adding or deleting a section.

CAUTION

When a section is removed from a specific incident type, all incidents of that type will lose the section along with any associated dynamic field values.

READER NOTE

Only reusable form items can be added via this command.

Implementation	System
Command Category	System Utility
Tags	INCIDENT DYNAMIC FORM

Inputs

Parameter Name

Required/Optional

Description

Sample Data

Incident Types

Required

The incident types to be modified.

JSON

["Incident Type 1", "Incident Type 2"]

Section

Required

The section to be added or deleted.

Privilege Escalation

Action

Required

The modification performed. The options are:

Add
Delete

Actions will execute idempotently, making no changes when adding a section that already exists or deleting a section that does not exist.

Delete

Output

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

{
    "Status": "Successful"
}

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/ModifyIncidentForm

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 Types": <Incident Types here>,
      "Section": <Section here>,
      "Action": <Action 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 Types	`array<string>`	Required	The incident types to be modified.
Section	`string`	Required	The section to be added or deleted.
Action	`string`	Required	The modification performed. The options are: Add Delete Actions will execute idempotently, making no changes when adding a section that already exists or deleting a section that does not exist.

Sample Request

SAMPLE DATA

JSON

{
    "Username": "Admin",
    "Site": "Security Operations",
    "CommandParams": {
        "Incident Types": [
            "demo_incident_form"
        ],
        "Section": "Privilege Escalation",
        "Action": "Delete"
    }
}

Response

Response Fields

Field Name	Type	Description
error	`string`	The error message if the API request has failed.
returnData	`string`	The return data from the API request.

Sample Response

JSON

{
    "error": "",
    "returnData": {
        "Status": "Successful"
    }
}