Get PreConfigured Report

Get report by given time range and pre-configured report type id.

Implementation	System
Command Category	System Utility
Tags	INCIDENT INCIDENT REPORTS

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Start Time	Required	Start time to retrieve the reports.	`08/01/2020 03:14 PM`
End Time	Required	End time to retrieve the reports.	`08/30/2020 12:14 PM`
Report Type	Optional	The type of the report.	`2`
Additional Fields	Optional	This function parameter allows for the addition of new fields to 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 can have 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	`DateTime`	Required	Start time to retrieve the reports.
End Time	`DateTime`	Required	End time to retrieve the reports.
Report Type	`Text`	Optional	The type of the report.
Additional Fields	`Text`	Optional	This function parameter allows for the addition of new fields to 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 can have 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	`Text`	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"
  }
}