Set Tasks as Key Findings
Set selected runtime tasks as key findings.
Reader Note
Please note that this command is only applicable within an incident Playbook.
Implementation | System |
Command Category | System Utility |
Tags | INCIDENT INCIDENT TASK |
Inputs
Parameter Name | Required/Optional | Description | Sample Data |
---|---|---|---|
Task Name Array | Optional | The id array of tasks that to be set as key findings |
JSON
|
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/SetTaskIndicatorByName
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": {
"Task Name Array": [
<Task Name 1 here>,
<Task Name 2 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. |
Task Name Array |
| Optional | The id array of tasks that to be set as key findings |
Sample Request
SAMPLE DATA
{
"Username": "Admin",
"Site": "Security Operations",
"CommandParams": {
"Task Name Array": [
"New Command Task 30",
"RemoveList"
]
}
}
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"
}