Remove Case Attachment
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. |
CODE
|
File Ids | Optional | The number array of Attachment file id. |
CODE
|
File Names | Optional | The text array of Attachment file name. |
CODE
|
Output
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
{
"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 |
| Required | The username of your D3 SOAR account. |
Site |
| Required | The D3 SOAR site to run the remote command. |
Case Numbers |
| Required | The text array of case number. |
File Ids |
| Optional | The number array of Attachment file id. |
File Names |
| Optional | The text array of Attachment file name. |
Sample Request
SAMPLE DATA
{
"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 |
| The error message if the API request has failed. |
returnData |
| The return data from the API request. |
Sample Response
{
"error": "",
"returnData": "Successful"
}