Breadcrumbs

Update Dynamic Form Value by Incident Number in bulk

Last updated: Aug 29, 2024

Updates the values of specified incident dynamic fields across multiple incidents, if all conditions are met.

Implementation

System

Command Category

System Utility

Tags

Incident Incident Dynamic Form

Inputs

Parameter Name

Required/Optional

Description

Sample Data

Input

Required

A JSON array where each object represents an incident, which could be the same or different incidents.

  • IncidentNumber: The unique identifier of the incident to be updated.

  • SectionName: The name of the Section within an incident form where the dynamic fields are located.

  • Condition: The conditions for updating the dynamic fields. It checks whether the Info Activity items have the specified values.

  • FieldValue: Contains the new values to be set for the specified Info Activity items, if all conditions are met. These can be the same or different Info Activity items as the ones specified in the Condition field.

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

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

array<JSON Object>

Required

This JSON array where each object represents an incident, which could be the same or different incidents.

  • IncidentNumber: The unique identifier of the incident to be updated.

  • SectionName: The name of the Section within an incident form where the dynamic fields are located.

  • Condition: The conditions for updating the dynamic fields. It checks whether the Info Activity items have the specified values.

  • FieldValue: Contains the new values to be set for the specified Info Activity items, if all conditions are met. These can be the same or different Info Activity items as the ones specified in the Condition field.

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

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.

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