Get Incident Form MetaData

LAST UPDATED: OCT 02, 2024

Retrieves an overview of all active incident forms within the D3 SOAR platform. Returned are the details for each form, including the sections and activities that can be performed within each section.

READER NOTE

This command is present in D3 vSOC versions 16.8 and above. Users running on lower vSOC versions must contact D3 to obtain access.

Implementation	System
Command Category	System Utility
Tags	INCIDENT FORM METADATA

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Form Names	Optional	The names of the incident forms for which the metadata will be retrieved. If this parameter is provided, only the incident forms matching any of the specified names will be retrieved(OR relationship within the parameter). If this parameter is not provided, metadata for all available incident forms will be returned.	JSON `[ "Data Breach", "Unauthorized Access" ]`
Section Names	Optional	The section names of the incident forms. If this parameter is provided, only incident forms that contain any of the specified section names will be returned (OR relationship within the parameter). Incident forms will only be returned if they match both the provided Form Names and Section Names (AND relationship between parameters).	JSON `[ "ST_Note", "Section_1", "User Information", "System Information" ]`

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",
    "Data": [
        {
            "IncidentFormName": "Data Breach",
            "Description": "",
            "IncidentCategory": [
                "Access",
                "Application",
                "AttrIR"
            ],
            "Sections": [
                {
                    "SectionId": 888,
                    "SectionName": "ST_Note",
                    "Items": [
                        {
                            "ItemId": 47173,
                            "DisplayOrder": 10,
                            "ItemCategory": "Info Activity",
                            "ItemName": "Username",
                            "ItemType": "Text Box",
                            "IsActive": true,
                            "IsRequired": false,
                            "IsRequiredOnClose": false
                        },
                        {
                            "ItemId": 47174,
                            "DisplayOrder": 10,
                            "ItemCategory": "Info Activity",
                            "ItemName": "Hostname",
                            "ItemType": "Text Box",
                            "IsActive": true,
                            "IsRequired": false,
                            "IsRequiredOnClose": false
                        }
                    ]
                },
                {
                    "SectionId": 889,
                    "SectionName": "Section_1",
                    "Items": [
                        {
                            "ItemId": 47175,
                            "DisplayOrder": 20,
                            "ItemCategory": "Info Activity",
                            "ItemName": "IP Address",
                            "ItemType": "Text Box",
                            "IsActive": true,
                            "IsRequired": false,
                            "IsRequiredOnClose": false
                        },
                        {
                            "ItemId": 47176,
                            "DisplayOrder": 20,
                            "ItemCategory": "Info Activity",
                            "ItemName": "File Hash",
                            "ItemType": "Text Box",
                            "IsActive": true,
                            "IsRequired": false,
                            "IsRequiredOnClose": false
                        }
                    ]
                }
            ]
        },
        {
            "IncidentFormName": "Unauthorized Access",
            "Description": "",
            "IncidentCategory": [
                "Access",
                "Application",
                "AttrIR"
            ],
            "Sections": [
                {
                    "SectionId": 890,
                    "SectionName": "User Information",
                    "Items": [
                        {
                            "ItemId": 47180,
                            "DisplayOrder": 10,
                            "ItemCategory": "Info Activity",
                            "ItemName": "User Email",
                            "ItemType": "Text Box",
                            "IsActive": true,
                            "IsRequired": true,
                            "IsRequiredOnClose": false
                        },
                        {
                            "ItemId": 47181,
                            "DisplayOrder": 10,
                            "ItemCategory": "Info Activity",
                            "ItemName": "User Phone",
                            "ItemType": "Text Box",
                            "IsActive": true,
                            "IsRequired": false,
                            "IsRequiredOnClose": false
                        }
                    ]
                },
                {
                    "SectionId": 891,
                    "SectionName": "System Information",
                    "Items": [
                        {
                            "ItemId": 47182,
                            "DisplayOrder": 20,
                            "ItemCategory": "Info Activity",
                            "ItemName": "Operating System",
                            "ItemType": "Dropdown",
                            "IsActive": true,
                            "IsRequired": true,
                            "IsRequiredOnClose": true,
                            "Options": [
                                {
                                    "OptionId": 47182,
                                    "OptionName": "Windows",
                                    "LinkedItems": [
                                        12345,
                                        12348
                                    ]
                                },
                                {
                                    "OptionId": 47183,
                                    "OptionName": "Linux",
                                    "LinkedItems": [
                                        12346,
                                        12312
                                    ]
                                }
                            ]
                        },
                        {
                            "ItemId": 47183,
                            "DisplayOrder": 20,
                            "ItemCategory": "Info Activity",
                            "ItemName": "Device Name",
                            "ItemType": "Text Box",
                            "IsActive": true,
                            "IsRequired": false,
                            "IsRequiredOnClose": false
                        }
                    ]
                }
            ]
        }
    ]
}

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

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": {
        "Form Names": [<Form Names here>],
        "Section Names": [<Section Names 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.
Form Names	`array<string>`	Optional	The names of the incident forms for which the metadata will be retrieved. If this parameter is provided, only the incident forms matching any of the specified names will be retrieved(OR relationship within the parameter). If this parameter is not provided, metadata for all available incident forms will be returned.
Section Names	`array<string>`	Optional	The section names of the incident forms. If this parameter is provided, only incident forms that contain any of the specified section names will be returned (OR relationship within the parameter). Incident forms will only be returned if they match both the provided Form Names and Section Names (AND relationship between parameters).

Sample Request

SAMPLE DATA

JSON

{
    "Username": "Admin",
    "Site": "Security Operations",
    "CommandParams": {
        "Form Names": [
            "Data Breach",
            "Unauthorized Access"
        ],
        "Section Names": [
            "ST_Note",
            "Section_1",
            "User Information",
            "System Information"
        ]
    }
}

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",
        "Data": [
            {
                "IncidentFormName": "Data Breach",
                "Description": "",
                "IncidentCategory": [],
                "Sections": [
                    {
                        "SectionID": 888,
                        "SectionName": "ST_Note",
                        "Items": [
                            {
                                "ItemId": 47174,
                                "DisplayOrder": 20,
                                "ItemCategory": "Info Activity",
                                "ItemName": "Hostname",
                                "ItemType": "Text Box",
                                "IsActive": false,
                                "IsRequired": false,
                                "IsRequiredOnClose": true
                            },
                            {
                                "ItemId": 47175,
                                "DisplayOrder": 30,
                                "ItemCategory": "Info Activity",
                                "ItemName": "IP Address",
                                "ItemType": "Text Box",
                                "IsActive": true,
                                "IsRequired": false,
                                "IsRequiredOnClose": false
                            },
                            {
                                "ItemId": 47176,
                                "DisplayOrder": 40,
                                "ItemCategory": "Info Activity",
                                "ItemName": "File Hash",
                                "ItemType": "Text Box",
                                "IsActive": true,
                                "IsRequired": false,
                                "IsRequiredOnClose": false
                            }
                        ]
                    }
                ]
            },
            {
                "IncidentFormName": "Unauthorized Access",
                "Description": "",
                "IncidentCategory": [],
                "Sections": [
                    {
                        "SectionID": 888,
                        "SectionName": "ST_Note",
                        "Items": [
                            {
                                "ItemId": 47174,
                                "DisplayOrder": 20,
                                "ItemCategory": "Info Activity",
                                "ItemName": "Hostname",
                                "ItemType": "Text Box",
                                "IsActive": false,
                                "IsRequired": false,
                                "IsRequiredOnClose": true
                            },
                            {
                                "ItemId": 47175,
                                "DisplayOrder": 30,
                                "ItemCategory": "Info Activity",
                                "ItemName": "IP Address",
                                "ItemType": "Text Box",
                                "IsActive": true,
                                "IsRequired": false,
                                "IsRequiredOnClose": false
                            },
                            {
                                "ItemId": 47176,
                                "DisplayOrder": 40,
                                "ItemCategory": "Info Activity",
                                "ItemName": "File Hash",
                                "ItemType": "Text Box",
                                "IsActive": true,
                                "IsRequired": false,
                                "IsRequiredOnClose": false
                            }
                        ]
                    }
                ]
            }
        ]
    }
}