Save Files From Playbooks or Events to IR Attachment

Saves files that selected from playbooks or events using IDs to IR Attachment.

Reader Note

Please note that this command is only applicable within an incident Playbook.

Implementation	System
Command Category	System Utility
Tags	INCIDENT INCIDENT ATTACHMENT

Inputs

Parameter Name	Required/Optional	Description	Sample Data
ID Array	Optional	The array of IDs of files to save to IR Attachment.	CODE `[ "237" ]`
Table Name	Optional	The table name in which the files are.	`PB_FILE`

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

Succeed

Context Data

The response data from the utility command.

SAMPLE DATA

JSON

[
    {
        "originalFileID": 237,
        "newFileID": 918,
        "fileName": "IR-20200119-276920200119104501.pdf",
        "description": "Summary IR Report IR-20200528-6620200527133229.pdf.",
        "MD5": "a166ff37ca915314ec0d4ecbfda4c0fc",
        "SHA1": "b1038aeda87dd7f4494e42006f3da99469d7973c",
        "SHA256": "fa0d1f2998a2cd6a5e48e508f2e05b13ad2053ee5f3e2d56cc8e7924df5b0b74"
    }
]

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

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": {
    "ID Array": "<ID Array here>",
    "Table Name": "<Table Name 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.
ID Array	`Text Array`	Optional	The array of IDs of files to save to IR Attachment.
Table Name	`Text`	Optional	The table name in which the files are.

Sample Request

SAMPLE DATA

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "ID Array": [
      "237"
    ],
    "Table Name": "PB_FILE"
  }
}

Response

Response Fields

Field Name	Type	Description
error	`Text`	The error message if the API request has failed.
returnData	`Text`	The return data from the API request.
contextData	`JSON Array`	The context data from the API request.

Sample Response

JSON

{
    "error": "",
    "returnData": "Succeed",
    "contextData": [
      {
          "originalFileID": 237,
          "newFileID": 918,
          "fileName": "IR-20200119-276920200119104501.pdf",
          "description": "Summary IR Report IR-20200528-6620200527133229.pdf.",
          "MD5": "a166ff37ca915314ec0d4ecbfda4c0fc",
          "SHA1": "b1038aeda87dd7f4494e42006f3da99469d7973c",
          "SHA256": "fa0d1f2998a2cd6a5e48e508f2e05b13ad2053ee5f3e2d56cc8e7924df5b0b74"
      }
    ]
}