Get PreConfigured Report

LAST UPDATED: SEPT 04, 2024

Generates a report of a specified type, that includes items created within the defined time range.

READER NOTE

The JSON file for the report can be downloaded from the Result tab in the Playbook Task Details popup within a D3 playbook.

Implementation	System
Command Category	System Utility
Tags	INCIDENT INCIDENT REPORTS

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Start Time	Required	The start of the time range (in UTC) used to select the relevant items for each type of report—such as incidents or cases. Only those items created within this range will be included in the report.	08/01/2020 03:14 PM
End Time	Required	The end of the range (in UTC) used to select the relevant items for each type of report—such as incidents or cases. Only those items created within this range will be included in the report.	08/30/2020 12:14 PM
Report Type	Optional	The type of the report. The options are: 1 - Case Management Report 2 - Incident Report 3 - Techniques & Tactics - Events 4 - Techniques & Tactics - Incidents 9 - Case & Incidents Report	2
Additional Fields	Optional	Allows for the inclusion of new fields in the output report, specifically for events (mapping field), incidents (dynamic field), and cases (custom form field). The configuration for these fields must be in JSON format. When adding fields for incidents and cases, the section name must be specified. It is important to note that each subject is limited to a maximum of 20 additional fields.	CODE `{ "Incident": [ { "SectionName": "Malwares", "FieldName": "Name" }, { "SectionName": "IP", "FieldName": "IP Address" }, { "SectionName": "Analyst Review", "FieldName": "Review Note" } ], "Case": [ { "SectionName": "Additional Infomation", "FieldName": "Address" }, { "SectionName": "Additional Infomation", "FieldName": "Email" } ], "Event": [ { "FieldName": "Event Type" }, { "FieldName": "Process ID" } ] }`

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

Successful

Context Data

The response data from the utility command.

SAMPLE DATA

JSON

{
    "fileName": "IncidentReport_20200801151435.json",
    "fileId": 437,
    "md5": "6619869ed0b148d5312ffbd0b9bc05d6",
    "sha1": "0ab0bf9100b782860f663b7aca51f8a109e7db01",
    "sha256": "422857990699c489e97dbf0559413559777172d487ab48f95de7ebbb76c10294"
}

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

Headers

Please refer to the page Webhook Configuration Guide - Authentication Method: API Keys for more details.

Request Body

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Start Time": "<Start Time here>",
    "End Time": "<End Time here>",
    "Report Type": "<Report Type here>,
    "Additional Fields": "<Additional Fields 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.
Start Time	`string`	Required	The start of the time range (in UTC) used to select the relevant items for each type of report—such as incidents or cases. Only those items created within this range will be included in the report.
End Time	`string`	Required	The end of the range (in UTC) used to select the relevant items for each type of report—such as incidents or cases. Only those items created within this range will be included in the report.
Report Type	`integer`	Optional	The type of the report. The options are: 1 - Case Management Report 2 - Incident Report 3 - Techniques & Tactics - Events 4 - Techniques & Tactics - Incidents 9 - Case & Incidents Report
Additional Fields	`JSON Object`	Optional	Allows for the inclusion of new fields in the output report, specifically for events (mapping field), incidents (dynamic field), and cases (custom form field). The configuration for these fields must be in JSON format. When adding fields for incidents and cases, the section name must be specified. It is important to note that each subject is limited to a maximum of 20 additional fields.

Sample Request

SAMPLE DATA

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Start Time": "08/01/2020 03:14 PM",
    "End Time": "08/30/2020 12:14 PM",
    "Report Type": 2,
    "Additional Fields": {
      "Incident": [
        {
          "SectionName": "Malwares",
          "FieldName": "Name"
        },
        {
          "SectionName": "IP",
          "FieldName": "IP Address"
        },
        {
          "SectionName": "Analyst Review",
          "FieldName": "Review Note"
        }
      ],
      "Case": [
        {
          "SectionName": "Additional Infomation",
          "FieldName": "Address"
        },
        {
          "SectionName": "Additional Infomation",
          "FieldName": "Email"
        }
      ],
      "Event": [
        {
          "FieldName": "Event Type"
        },
        {
          "FieldName": "Process ID"
        }
      ]
    }
  }
}

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.
contextData	`JSON Object`	The context data from the API request.

Sample Response

JSON

{
    "error": "",
    "returnData": "Successful",
    "contextData": {
      "fileName": "IncidentReport_20200801151435.json",
      "fileId": 437,
      "md5": "6619869ed0b148d5312ffbd0b9bc05d6",
      "sha1": "0ab0bf9100b782860f663b7aca51f8a109e7db01",
      "sha256": "422857990699c489e97dbf0559413559777172d487ab48f95de7ebbb76c10294"
  }
}