Remove Case Attachment | docs.d3security

Last updated: Feb 27, 2024

Remove File Attachments From Cases.

Implementation	System
Command Category	System Utility
Tags	Case

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Case Numbers	Required	The text array of case number.	`[ "20220111-1", "20220111-2", "20220111-3" ]`
File Ids	Optional	The number array of Attachment file id.	`[ 1153, 1154, 1155 ]`
File Names	Optional	The text array of Attachment file name.	`[ "test01.png", "test02.png", "test03.png" ]`

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

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

https:/{base_url}/{api_namespace}/api/Command/RemoveCaseAttachment

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": {
    "Case Numbers": "<Case Numbers here>",
    "File Ids": "<File Ids here>",
    "File Names": "<File 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.
Case Numbers	`Text Array`	Required	The text array of case number.
File Ids	`Number Array`	Optional	The number array of Attachment file id.
File Names	`Text Array`	Optional	The text array of Attachment file name.

Sample Request

Sample Data

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Case Numbers": [
      "20220111-1",
      "20220111-2",
      "20220111-3"
    ],
    "File Ids": [
      1153,
      1154,
      1155
    ],
    "File Names": [
      "test01.png",
      "test02.png",
      "test03.png"
    ]
  }
}

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.

Sample Response

JSON

{
    "error": "",
    "returnData": "Successful"
}