Get Incident Dynamic Field Values
LAST UPDATED: FEB 27, 2024
Get the values of the specified incident dynamic field in all instances by conditions
Implementation | System |
Command Category | System Utility |
Tags | INCIDENT INCIDENTDYNAMICFORM |
Inputs
Parameter Name | Required/Optional | Description | Sample Data |
---|---|---|---|
Incident Number | Optional | The Incident Number to get the dynamica fields from. |
|
Section Name | Optional | The name of the dynamic section. |
|
Conditions | Optional | Conditions for filtering dynamic form instances in the specified dynamic section. |
CODE
|
Field Name | Optional | The name of the dynamic field to retrive from the dynamic section. |
|
Output
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/GetIncidentDynamicFieldsValueByIncidentNum
Headers
Please refer to the page Webhook Configuration Guide - Authentication Method: API Keys for more details.
Request Body
{
"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 |
| Required | The username of your D3 SOAR account. |
Site |
| Required | The D3 SOAR site to run the remote command. |
Incident Number |
| Optional | The Incident Number to get the dynamica fields from. |
Section Name |
| Optional | The name of the dynamic section. |
Conditions |
| Optional | Conditions for filtering dynamic form instances in the specified dynamic section. |
Field Name |
| Optional | The name of the dynamic field to retrive from the dynamic section. |
Sample Request
SAMPLE DATA
{
"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 |
| The error message if the API request has failed. |
keyFields |
| The key fields from the API request. |
returnData |
| The return data from the API request. |
contextData |
| The context data from the API request. |
Sample Response
{
"error": "",
"keyFields": {
"FieldValue" : [
{
"InstanceId": "1",
"Value": [
"user01@example.com"
]
}
]
}
"returnData": "Succeed",
"contextData": {
"fieldName": "Email",
"fieldValue": [
{
"InstanceId": "1",
"Value": [
"user01@example.com"
]
}
]
}
}