Create Task | docs.d3security

Last updated: Sept 09, 2024

Creates an ad-hoc task and assigns it to a user. The assigned task can be viewed within the Your Pending Tasks section of the Overview Tab or the dashboard of the Pending Tasks Tab.

Implementation	System
Command Category	System Utility
Tags	incident Task

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Task Name	Required	The name of the ad-hoc task.	Sample Task
Task Type	Optional	The type of the ad-hoc task.	Default
Task Description	Optional	A description for the ad-hoc task.	Sample Task Description
Assignee	Required	The user who is assigned the ad-hoc task.	admin user
Due Date	Optional	The due date of the ad-hoc task.	2022-03-24 13:28:13
Required	Optional	Whether the assigned user must complete this task to close the incident.	Yes
Incident Number	Optional	The incident number corresponding to an incident within which to create the ad-hoc task.	20220125-1

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

Raw Data

The response data from the utility command.

Sample Data

JSON

{
    "Task Name": "Sample Task",
    "Task Type": "Default",
    "Task Description": "<p>Sample Task Description</p>",
    "Assignee": "admin user",
    "Due Date": "2022-03-24 13:28:13 China Standard Time",
    "Required on incident close": "Required",
    "Creator": "admin user",
    "Incident Number": "20220125-1"
}

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

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": {
    "Task Name": <Task Name here>,
    "Task Type": <Task Type here>,
    "Task Description": <Task Description here>,
    "Assignee": <Assignee here>,
    "Due Date": <Due Date here>,
    "Required": <Required here>,
    "Incident Number": <Incident Number 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.
Task Name	`string`	Required	The name of the ad-hoc task.
Task Type	`string`	Optional	The type of the ad-hoc task.
Task Description	`string`	Optional	A description for the ad-hoc task.
Assignee	`string`	Required	The user who is assigned the ad-hoc task.
Due Date	`string`	Optional	The due date of the ad-hoc task.
Required	`string`	Optional	Whether the assigned user must complete this task to close the incident.
Incident Number	`string`	Optional	The incident number corresponding to an incident within which to create the ad-hoc task.

Sample Request

Sample Data

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Task Name": "Sample Task ",
    "Task Type": "Default",
    "Task Description": "Sample Task Description",
    "Assignee": "admin user",
    "Due Date": "2022-03-24 13:28:13",
    "Required": "Yes",
    "Incident Number": "20220125-1"
  }
}

Response

Response Fields

Field Name	Type	Description
error	`string`	The error message if the API request has failed.
returnData	`string`	The return data from the API request.
rawData	`JSON Object`	The raw data from the API request.

Sample Response

JSON

{
    "error": "",
    "returnData": "Successful",
    "rawData": {
        "Task Name": "Sample Task",
        "Task Type": "Default",
        "Task Description": "<p>Sample Task Description</p>",
        "Assignee": "admin user",
        "Due Date": "2022-03-24 13:28:13 China Standard Time",
        "Required on incident close": "Required",
        "Creator": "admin user",
        "Incident Number": "20220125-1"
    }
}