Get Incident Completed Task
LAST UPDATED: FEB 27, 2024
Retrieves all incident completed tasks' information
Implementation | System |
Command Category | System Utility |
Tags | INCIDENT TASK |
Inputs
Parameter Name | Required/Optional | Description | Sample Data |
---|---|---|---|
Incident Number | Optional | The Incident number of the completed task | 20220129-3 |
Task Completion Method | Optional | The option of task completion method | Auto Complete |
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/GetIncidentCompletedTask
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": {
"Incident Number": <Incident Number here>,
"Task Completion Method": <Task Completion Method 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. |
Incident Number |
| Optional | The Incident number of the completed task |
Task Completion Method |
| Optional | The option of task completion method |
Sample Request
SAMPLE DATA
{
"Username": "Admin",
"Site": "Security Operations",
"CommandParams": {
"Incident Number": "20220129-3",
"Task Completion Method": "Auto Complete"
}
}
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. |
contextData |
| The context data from the API request. |
Sample Response
{
"error": "",
"returnData": "Successful",
"contextData": {
"Auto Complete": [
{
"Task Name": "New Data Formatter Task 45",
"Task Completion Method": "Auto Run",
"User Name": "admin user",
"Start Utctime": "1/28/2022 10:33:16 PM",
"End Utctime": "1/28/2022 10:33:17 PM"
},
{
"Task Name": "New Stage Task 12",
"Task Completion Method": "Auto Run",
"User Name": "admin user",
"Start Utctime": "1/28/2022 10:33:16 PM",
"End Utctime": "1/28/2022 10:33:16 PM"
}
]
}
}