Skip to main content
Skip table of contents

Get Incident Completed Task ‎‎

POST /Command/GetIncidentCompletedTask

Get all incident completed tasks' information.

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.

Incident Number

string

Required

The Incident number of the completed task

Task Completion Method

string

Optional

The option of task completion method: Auto Complete/Manual Complete/Both

Body Sample Data

application/json
JSON
{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Incident Number": "20220129-3",
    "Task Completion Method": "Auto Complete"
  }
}

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.

contextData

JSON Object

The context data from the API request.

Sample Data

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

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

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.