Create Task

Create a task and assign to a user.

Implementation	System
Command Category	System Utility
Tags	INCIDENT INCIDENT TASK

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Task Name	Optional	The task name.	`Sample Task`
Task Type	Optional	Ad Hoc Task Type	`Default`
Task Description	Optional	The task description.	`Sample Task Description`
Assignee	Optional	The user who is assigned to the task.	`admin user`
Due Date	Optional	Due date of the task.	`2022-03-24 13:28:13`
Required	Optional	Assigned user must complete this task to close the incident.	`Yes`
Incident Number	Optional	The Incident number of the create 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

CODE

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": "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"
  }
}

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`	Optional	The task name.
Task Type	`Text`	Optional	Ad Hoc Task Type
Task Description	`Text`	Optional	The task description.
Assignee	`Text`	Optional	The user who is assigned to the task.
Due Date	`DateTime`	Optional	Due date of the task.
Required	`Text`	Optional	Assigned user must complete this task to close the incident.
Incident Number	`Text`	Optional	The Incident number of the create 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"
    }
}