Skip to main content
Skip table of contents

Update Dynamic Form Value by Incident Number‎

POST /Command/UpdateDynamicFieldsByNumber

Sets the values of specified incident dynamic fields in all instances in a given incident's dynamic section by conditions.

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 number of incident to update on.

Section Name

string

Required

The name of the dynamic section.

Conditions

JSON Object

Required

Conditions for filtering dynamic form instances in the specified dynamic section.

Field Values

JSON Object

Required

Field and value pairs for setting the incident dynamic fields.

Body Sample Data

application/json
JSON
{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Incident Number": "20200530-303",
    "Section Name": "MySection",
    "Conditions": {
      "FirstName": "Bob",
      "LastName": "James"
    },
    "Field Values": {
      "Email": "user01@example.com",
      "PhoneNumber": "6040000000"
    }
  }

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.

JSON
{
    "error": "",
    "keyFields": {
      "IncidentNumber": "20200530-303",
      "ModifiedDate": "5/30/2020 10:01:26 AM",
      "ModifiedBy": "admin user"
    },
    "returnData": "Succeed",
    "contextData": {
        "incidentNumber": "20200530-303",
        "sectionName": "MySection",
        "condition": {
            "FirstName": "Bob",
            "LastName": "James"
        },
        "fieldAndValue": {
            "Email": "user01@example.com",
            "PhoneNumber": "6040000000"
        },
        "modifiedDate": "5/30/2020 10:01:26 AM",
        "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."}
JavaScript errors detected

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

If this problem persists, please contact our support.