Update Dynamic Form Value by Incident Number in bulk

Sets the values of specified incident dynamic fields in all instances in multiple incidents' dynamic section by conditions.

Implementation	System
Command Category	System Utility
Tags	INCIDENT INCIDENT DYNAMIC FORM

Inputs

Parameter Name

Required/Optional

Description

Sample Data

Input

Optional

The JSON Array with incidents' dynamic field/value pairs to update with. DateFormat: yyyy-MM-dd HH:mm:ss.

CODE

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

Output

Return Data

The returned result of this command. If some required parameters are not defined, this returned data could be empty. The returned result can be passed down directly to a subsequent command in playbooks.

SAMPLE DATA

JSON

Successful

Context Data

The response data from the utility command.

SAMPLE DATA

JSON

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

Remote Command API

The D3 command API allows you to send requests to D3 SOAR to execute this utility command via REST API.

Request

POST

CODE

https:/{base_url}/{api_namespace}/api/Command/UpdateDynamicFieldsByNumberInBulk

Headers

Please refer to the page Webhook Configuration Guide - Authentication Method: API Keys for more details.

Request Body

JSON

{
  "Username": "<Username here>",
  "Site": "<Site here>",
  "CommandParams": {
    "Input": "<Input here>"
  }
}

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	`JSON Array`	Optional	The JSON Array with incidents' dynamic field/value pairs to update with. DateFormat: yyyy-MM-dd HH:mm:ss.

Sample Request

SAMPLE DATA

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

Response Fields

Field Name	Type	Description
error	`Text`	The error message if the API request has failed.
returnData	`Text`	The return data from the API request.
contextData	`JSON Array`	The context data from the API request.

Sample Response

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