Get Incident Dynamic Field Values

LAST UPDATED: SEPT 09, 2024

Retrieves the values of the specified incident dynamic field for an incident.

Implementation	System
Command Category	System Utility
Tags	INCIDENT DYNAMIC FIELD

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Incident Number	Optional	The incident number corresponding to an incident for which the dynamic field values will be retrieved. If left empty, the runtime incident will be used.	090924-13297
Section Name	Required	The name of the dynamic section.	demoSection
Conditions	Optional	The conditions for filtering dynamic form instances in the specified dynamic section.	CODE `{ "FirstName": "Bob", "LastName": "James" }`
Field Name	Optional	The specific dynamic field (i.e. Info Activity) from which to retrieve data. If left empty, the data for all dynamic fields will be displayed.	Email

Output

Key Fields

Important key-value pairs extracted from Raw Data.

SAMPLE DATA

JSON

{
  "FieldValue" : [
    {
        "InstanceId": "1",
        "Value": [
            "user01@example.com"
        ]
    }
  ]
}

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

Succeed

Context Data

The response data from the utility command.

SAMPLE DATA

JSON

{
    "fieldName": "Email",
    "fieldValue": [
        {
            "InstanceId": "1",
            "Value": [
                "user01@example.com"
            ]
        }
    ]
}

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/GetIncidentDynamicFieldsValueByIncidentNum

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": {
    "Incident Number": "<Incident Number here>",
    "Section Name": "<Section Name here>",
    "Conditions": "<Conditions here>",
    "Field Name": "<Field Name 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.
Incident Number	`string`	Optional	The incident number corresponding to an incident for which the dynamic field values will be retrieved. If left empty, the runtime incident will be used.
Section Name	`array<string>`	Required	The name of the dynamic section.
Conditions	`JSON Object`	Optional	The conditions for filtering dynamic form instances in the specified dynamic section.
Field Name	`string`	Optional	The specific dynamic field (i.e. Info Activity) from which to retrieve data. If left empty, the data for all dynamic fields will be displayed.

Sample Request

SAMPLE DATA

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Incident Number": "20110803-1",
    "Section Name": "MySection",
    "Conditions": {
      "FirstName": "Bob",
      "LastName": "James"
    },
    "Field Name": "Email"
  }
}

Response

Response Fields

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.

Sample Response

JSON

{
    "error": "",
    "keyFields": {
      "FieldValue" : [
        {
        "InstanceId": "1",
        "Value": [
            "user01@example.com"
          ]
        }
      ]
    }
    "returnData": "Succeed",
    "contextData": {
      "fieldName": "Email",
      "fieldValue": [
        {
            "InstanceId": "1",
            "Value": [
                "user01@example.com"
            ]
        }
      ]
    }
}