Get Incident Dynamic Field Values ‎‎ ‎

POST /Command/GetIncidentDynamicFieldsValueByIncidentNum

Get the values of the specified incident dynamic field in all instances 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.
Incident Number	`string`	Required	The Incident Number to get the dynamic fields from.
Section Name	`array<string>`	Required	The name of the dynamic section.
Conditions	`JSON Object`	Optional	Conditions for filtering dynamic form instances in the specified dynamic section.
Field Name	`string`	Required	The name of the dynamic field to retrieve from the dynamic section.

Body Sample Data

application/json

JSON

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

Response

200 OK

application/json

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 Data

CODE

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

400 BadRequest

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

{"Error": "The body of the request must be a valid JSON object"}

401 Unauthorized

application/json

Response Fields

Field Name	Type	Description
Error	`string`	A error message when the API request fails.

Sample Data

JSON

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

JSON

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

JSON

{"Error": "Unexpected Error."}