Update Dynamic Form Value by Incident Number in bulk‎

POST /Command/UpdateDynamicFieldsByNumberInBulk

Sets the values of specified incident dynamic fields in all instances in multiple incidents' 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.
Input	`array<JSON Object>`	Required	The JSON Array with incidents' dynamic field/value pairs to update with. DateFormat: yyyy-MM-dd HH:mm:ss.

Body Sample Data

application/json

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Input": [
      {
        "IncidentNumber": "20221109-2",
        "SectionName": "incident test section",
        "Condition": {
          "ItemNoOption": "70"
        },
        "FieldValue": {
          "ItemNoOption3": "180"
        }
      },
      {
        "IncidentNumber": "20221108-1",
        "SectionName": "incident test section",
        "Condition": {
          "ItemNoOption": "80"
        },
        "FieldValue": {
          "ItemNoOption3": "180"
        }
      }
    ]
  }
}

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	`array<JSON object>`	The context data from the API request.

JSON

{
    "error": "",
    "returnData": "Successful",
    "contextData": [
        {
            "incidentNumber": "20221109-2",
            "sectionName": "incident test section",
            "condition": {
                "ItemNoOption": "70"
            },
            "fieldAndValue": {
                "ItemNoOption3": "180"
            },
            "modifiedDate": "11/17/2022 10:36:53 AM",
            "result": "Succeed",
            "modifiedBy": "admin user"
        },
        {
            "incidentNumber": "20221108-1",
            "sectionName": "incident test section",
            "condition": {
                "ItemNoOption": "80"
            },
            "fieldAndValue": {
                "ItemNoOption3": "180"
            },
            "modifiedDate": "11/17/2022 10:36:53 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

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