Create Task ‎

POST /Command/CreateTask

Create a task and assign to a user.

Request

Authentication: API keys or JSON web tokens (JWT)

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

READER NOTE

For Date/Time parameter Due Date, all times and timestamps must follow the format: yyyy-mm-dd HH:mm:ss.

e.g. May 15, 2024, 2:32 PM should be written as 2024-05-15 14:32:00.

Body Sample Data

application/json

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

200 OK

application/json

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 Data

CODE

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

400 BadRequest

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "The body of the request must be a valid JSON object"}

401 Unauthorized

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "Invalid authentication key."}

429 TooManyRequests

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "The request exceeds rate limits or is otherwise blocked by rate limiting policies."}

500 InternalServerError

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "Unexpected Error."}