Set Incident Field HTML‎ | docs.d3security

POST /Command/SetIncidentFieldHTML

Adds a description/note/conclusion in HTML format to the current incident.

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 to set the fields to.
Field Name	`string`	Required	The field that would be set in the incident.
HTML Content	`string`	Required	Content in HTML String.

Body Sample Data

application/json

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Incident Number": "20230405-12",
    "Field Name": "Note",
    "HTML Content": "
      192.168.1.xxx	Low
      192.168.1.xxx	High
      "
  }
}

Response

200 OK

application/json

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.

JSON

{
    "error": "",
    "returnData": "Successful",
    "contextData": {
        "IncidentNumber": "TEST-INCIDENT-51",
        "ModifiedDate": "6/17/2021 1:30:35 PM",
        "Notes": "Test incident notes",
        "Result": "Succeed",
        "ModifiedBy": "D3 admin"
    }
}

401 Unauthorized

application/json

Response Fields

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

Sample Data

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

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

{"Error": "Unexpected Error."}