Skip to main content
Skip table of contents

Add Investigation Table Content

LAST UPDATED: SEPT 11, 2024

Adds a table to an incident investigation section.

Implementation

System

Command Category

System Utility

Tags

INCIDENT

Inputs

Parameter Name

Required/Optional

Description

Sample Data

Incident Number

Required

The incident number corresponding to an incident for which to add investigation details.

20220829-13

Investigation Section

Required

The section for which to add investigation details, in table format. The options are:

  • Findings:lnitial findings

  • Findings:Data Enrichments

  • Findings:Data Correlations

  • Findings:lndicators of Attack (IOA)

  • Findings:lndicators of Compromise (IOC)

  • Remediations and Mitigations

  • Recommendations

If IOA or IOC is selected, data tables will be created and displayed under findings, but they will not appear in the Link Analysis tab. Use the Add Investigation Details command to populate IOA or IOC nodes in Link Analysis.

Summary

Investigation Detail in JSON

Required

The JSON data used for creating a table. The following are the permissible keys:

Title - A string that defines the title of the table.

Description - A brief description of the purpose or context of the table.

Fields - An array that lists the fields (i.e. headers) of the table, where each field contains:

  • Title: The display name of the field.

  • Name: The corresponding key used in the Data.

Data - An array of objects containing the actual data for each field, used to create the rows of the table. Each object can only include keys defined by the Name values within Fields.

Highlight (optional) - An array specifying the text elements to be highlighted. It includes:

  • Text - The data to be highlighted.

  • IsBold - A boolean (lowercase true or false) indicating whether the highlighted text should be bold.

  • Color - The hexadecimal RGB color code for highlighting, beginning with a # character.

CODE
{
  "Title": "Sample Datatable",
  "Description": "An example to add a table to investigation tab of an incident.",
  "Fields": [
    {
      "Title": "Name",
      "Name": "name"
    },
    {
      "Title": "Age",
      "Name": "age"
    },
    {
      "Title": "Address",
      "Name": "address"
    },
    {
      "Title": "Date",
      "Name": "date"
    }
  ],
  "Data": [
    {
      "name": "John Brown",
      "age": 18,
      "address": "New York No. 1 Lake Park",
      "date": "2016-10-03"
    },
    {
      "name": "Jim Green",
      "age": 24,
      "address": "London No. 1 Lake Park",
      "date": "2016-10-01"
    },
    {
      "name": "Joe Black",
      "age": 30,
      "address": "Sydney No. 1 Lake Park",
      "date": "2016-10-02"
    },
    {
      "name": "Jon Snow",
      "age": 26,
      "address": "Ottawa No. 2 Lake Park",
      "date": "2016-10-04"
    }
  ],
  "Highlight": [
    {
      "Text": [
        "John"
      ],
      "IsBold": true,
      "Color": "#42c765"
    }
  ]
}

Editing Type

Required

Whether to add an additional table or overwrite the existing content within the specified Investigation Section.

Overwrite

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
[
    {
        "ID": 36,
        "IncidentId": 166,
        "TypeId": 201,
        "Creator": 1,
        "LastModifiedBy": 1,
        "CreatedUtcTime": "2023-04-14T18:27:25.167",
        "CreatedTime": "2023-04-14T19:27:00",
        "LastModifiedUtcTime": "2023-04-17T19:12:42.450",
        "LastModifiedTime": "2023-04-17T20:12:00",
        "InvestigationDetail": [
            {
                "ID": 141,
                "InvestigationId": 36,
                "AddedBy": 1,
                "LastModifiedBy": 1,
                "RuntimeTaskId": -1,
                "Data": "{\r\n  \"Titile\": \"Sample Datatable\",\r\n  \"Description\": \"An example to add a table to investigation tab of an incident.\",\r\n  \"Fields\": [\r\n    {\r\n      \"Title\": \"Name\",\r\n      \"Name\": \"name\"\r\n    },\r\n    {\r\n      \"Title\": \"Age\",\r\n      \"Name\": \"age\"\r\n    },\r\n    {\r\n      \"Title\": \"Address\",\r\n      \"Name\": \"address\"\r\n    },\r\n    {\r\n      \"Title\": \"Date\",\r\n      \"Name\": \"date\"\r\n    }\r\n  ],\r\n  \"Data\": [\r\n    {\r\n      \"name\": \"John Brown\",\r\n      \"age\": 18,\r\n      \"address\": \"New York No. 1 Lake Park\",\r\n      \"date\": \"2016-10-03\"\r\n    },\r\n    {\r\n      \"name\": \"Jim Green\",\r\n      \"age\": 24,\r\n      \"address\": \"London No. 1 Lake Park\",\r\n      \"date\": \"2016-10-01\"\r\n    },\r\n    {\r\n      \"name\": \"Joe Black\",\r\n      \"age\": 30,\r\n      \"address\": \"Sydney No. 1 Lake Park\",\r\n      \"date\": \"2016-10-02\"\r\n    },\r\n    {\r\n      \"name\": \"Jon Snow\",\r\n      \"age\": 26,\r\n      \"address\": \"Ottawa No. 2 Lake Park\",\r\n      \"date\": \"2016-10-04\"\r\n    }\r\n  ]\r\n}",
                "Type": 1,
                "CreatedUtcTime": "2023-04-17T19:12:42.450",
                "CreatedTime": "2023-04-17T20:12:00",
                "LastModifiedUtcTime": "2023-04-17T19:12:42.450",
                "LastModifiedTime": "2023-04-17T20:12:00",
                "IsDeleted": 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/AddInvestigationTableContent

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>",
    "Investigation Section": "<Investigation Section here>",
    "Investigation Detail in JSON": "<Investigation Detail in JSON here>",
    "Editing Type": "<Editing Type 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

string

Required

The incident number corresponding to an incident for which to add investigation details.

Investigation Section

string

Required

The section for which to add investigation details, in table format. The options are:

  • Findings:lnitial findings

  • Findings:Data Enrichments

  • Findings:Data Correlations

  • Findings:lndicators of Attack (IOA)

  • Findings:lndicators of Compromise (IOC)

  • Remediations and Mitigations

  • Recommendations

If IOA or IOC is selected, data tables will be created and displayed under findings, but they will not appear in the Link Analysis tab. Use the Add Investigation Details command to populate IOA or IOC nodes in Link Analysis.

Investigation Detail in JSON

JSON Object

Required

The JSON data used for creating a table. The following are the permissible keys:

Title - A string that defines the title of the table.

Description - A brief description of the purpose or context of the table.

Fields - An array that lists the fields (i.e. headers) of the table, where each field contains:

  • Title: The display name of the field.

  • Name: The corresponding key used in the Data.

Data - An array of objects containing the actual data for each field, used to create the rows of the table. Each object can only include keys defined by the Name values within Fields.

Highlight (optional) - An array specifying the text elements to be highlighted. It includes:

  • Text - The data to be highlighted.

  • IsBold - A boolean (lowercase true or false) indicating whether the highlighted text should be bold.

  • Color - The hexadecimal RGB color code for highlighting, beginning with a # character.

Editing Type

string

Required

Whether to add an additional table or overwrite the existing content within the specified Investigation Section.

Sample Request

SAMPLE DATA

JSON
{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Incident Number": "20220829-13",
    "Investigation Section": "Summary",
    "Investigation Detail in JSON": {
      "Title": "Sample Datatable",
      "Description": "An example to add a table to investigation tab of an incident.",
      "Fields": [
        {
          "Title": "Name",
          "Name": "name"
        },
        {
          "Title": "Age",
          "Name": "age"
        },
        {
          "Title": "Address",
          "Name": "address"
        },
        {
          "Title": "Date",
          "Name": "date"
        }
      ],
      "Data": [
        {
          "name": "John Brown",
          "age": 18,
          "address": "New York No. 1 Lake Park",
          "date": "2016-10-03"
        },
        {
          "name": "Jim Green",
          "age": 24,
          "address": "London No. 1 Lake Park",
          "date": "2016-10-01"
        },
        {
          "name": "Joe Black",
          "age": 30,
          "address": "Sydney No. 1 Lake Park",
          "date": "2016-10-02"
        },
        {
          "name": "Jon Snow",
          "age": 26,
          "address": "Ottawa No. 2 Lake Park",
          "date": "2016-10-04"
        }
      ],
      "Highlight": [
        {
          "Text": [
            "John"
          ],
          "IsBold": true,
          "Color": "#42c765"
        }
      ]
    },
    "Editing Type": "Overwrite"
  }
}

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

array<JSON Object>

The context data from the API request.

Sample Response

JSON
{
    "error": "",
    "returnData": "Successful",
    "contextData": "[
    {
        "ID": 36,
        "IncidentId": 166,
        "TypeId": 201,
        "Creator": 1,
        "LastModifiedBy": 1,
        "CreatedUtcTime": "2023-04-14T18:27:25.167",
        "CreatedTime": "2023-04-14T19:27:00",
        "LastModifiedUtcTime": "2023-04-17T19:12:42.450",
        "LastModifiedTime": "2023-04-17T20:12:00",
        "InvestigationDetail": [
            {
                "ID": 141,
                "InvestigationId": 36,
                "AddedBy": 1,
                "LastModifiedBy": 1,
                "RuntimeTaskId": -1,
                "Data": "{\r\n  \"Titile\": \"Sample Datatable\",\r\n  \"Description\": \"An example to add a table to investigation tab of an incident.\",\r\n  \"Fields\": [\r\n    {\r\n      \"Title\": \"Name\",\r\n      \"Name\": \"name\"\r\n    },\r\n    {\r\n      \"Title\": \"Age\",\r\n      \"Name\": \"age\"\r\n    },\r\n    {\r\n      \"Title\": \"Address\",\r\n      \"Name\": \"address\"\r\n    },\r\n    {\r\n      \"Title\": \"Date\",\r\n      \"Name\": \"date\"\r\n    }\r\n  ],\r\n  \"Data\": [\r\n    {\r\n      \"name\": \"John Brown\",\r\n      \"age\": 18,\r\n      \"address\": \"New York No. 1 Lake Park\",\r\n      \"date\": \"2016-10-03\"\r\n    },\r\n    {\r\n      \"name\": \"Jim Green\",\r\n      \"age\": 24,\r\n      \"address\": \"London No. 1 Lake Park\",\r\n      \"date\": \"2016-10-01\"\r\n    },\r\n    {\r\n      \"name\": \"Joe Black\",\r\n      \"age\": 30,\r\n      \"address\": \"Sydney No. 1 Lake Park\",\r\n      \"date\": \"2016-10-02\"\r\n    },\r\n    {\r\n      \"name\": \"Jon Snow\",\r\n      \"age\": 26,\r\n      \"address\": \"Ottawa No. 2 Lake Park\",\r\n      \"date\": \"2016-10-04\"\r\n    }\r\n  ]\r\n}",
                "Type": 1,
                "CreatedUtcTime": "2023-04-17T19:12:42.450",
                "CreatedTime": "2023-04-17T20:12:00",
                "LastModifiedUtcTime": "2023-04-17T19:12:42.450",
                "LastModifiedTime": "2023-04-17T20:12:00",
                "IsDeleted": false
            }
        ]
    }
  ]"
}
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.