Set Incident Field‎

POST /Command/SetIncidentField

Set the incident field to a specific value. Please note that the 'Title' field cannot exceed 100 characters. If it exceeds the limit, any extra characters will be truncated.

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 of.
Field Name	`string`	Required	The field name that would be set in the incident.
Field Value	`string`	Required	The field value that would be set in the incident.

Body Sample Data

application/json

CODE

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Incident Number": "20200527-244",
    "Field Name": "Title",
    "Field Value": "New Incident Title"
  }
}

Response

200 OK

application/json

Field Name	Type	Description
error	`string`	The error message if the API request has failed.
keyFields	`JSON Object`	The key fields from the API request.
returnData	`string`	The return data from the API request.
contextData	`JSON Object`	The context data from the API request.

CODE

{
    "error": "",
    "keyFields": {
      "IncidentNumber": "20200527-244",
      "FieldName": "title",
      "FieldNewValue": "New Incident Title",
      "ModifiedDate": "5/27/2020 3:00:55 PM",
      "Result": "Succeed",
      "ModifiedBy": "admin user"
    },
    "returnData": "Succeed",
    "contextData": {
        "incidentNumber": "20200527-244",
        "fieldName": "title",
        "fieldNewVlaue": "New Incident Title",
        "modifiedDate": "5/27/2020 3:00:55 PM",
        "result": "Succeed",
        "modifiedBy": "admin user"
    }
}

401 Unauthorized

application/json

Response Fields

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

Sample Data

CODE

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

CODE

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

CODE

{"Error": "Unexpected Error."}