Copy Event Field Mapping

LAST UPDATED: AUG 19, 2024

Copies the event field mapping from one integration to another. Event field mappings in the destination integration will be overwritten by the data from the origin integration.

CAUTION

This action is irreversible.

Implementation	System
Command Category	System Utility
Tags	INTEGRATION EVENT FIELD MAPPING

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Integration to Copy From	Required	The integration from which event field mappings are copied.	Integration1
Integration to Copy To	Required	The destination integration where the event field mappings will be copied.	Integration2

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

[
    {
        "Event Source Name": "Event Source 1",
        "Data Copied": [
            {
                "Field Name": "Action Results",
                "Source Field": "$.test",
                "Source Type": "Text",
                "Source Regex": "",
                "Source Format": "",
                "Artifact Type": "",
                "Artifact Role": "",
                "Show Key Field": "",
                "Sort Order": ""
            },
            {
                "Field Name": "Action Results ID",
                "Source Field": "$.myField",
                "Source Type": "Text",
                "Source Regex": "",
                "Source Format": "",
                "Artifact Type": "",
                "Artifact Role": "",
                "Show Key Field": "",
                "Sort Order": ""
            }
        ]
    },
    {
        "Event Source Name": "Event Source 2",
        "Data Copied": [
            {
                "Field Name": "Action Results",
                "Source Field": "$.mySourceField",
                "Source Type": "Text",
                "Source Regex": "",
                "Source Format": "",
                "Artifact Type": "",
                "Artifact Role": "",
                "Show Key Field": "",
                "Sort Order": ""
            },
            {
                "Field Name": "Action Results ID",
                "Source Field": "$.myField",
                "Source Type": "Text",
                "Source Regex": "",
                "Source Format": "",
                "Artifact Type": "",
                "Artifact Role": "",
                "Show Key Field": "",
                "Sort Order": ""
            }
        ]
    }
]

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

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": {
    "Integration to Copy From": <Source Integration Name here>,
    "Integration to Copy To": <Destination Integration 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.
Integration to Copy From	`string`	Optional	Integration Name that is being copied from.
Integration to Copy To	`string`	Optional	Integration Name that is being copied to.

Sample Request

SAMPLE DATA

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Integration to Copy From": "Integration1",
    "Integration to Copy To": "Integration2"
  }
}

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":[
      {
          "Event Source Name": "Event Source 1",
          "Data Copied": [
              {
                  "Field Name": "Action Results",
                  "Source Field": "$.test",
                  "Source Type": "Text",
                  "Source Regex": "",
                  "Source Format": "",
                  "Artifact Type": "",
                  "Artifact Role": "",
                  "Show Key Field": "",
                  "Sort Order": ""
              },
              {
                  "Field Name": "Action Results ID",
                  "Source Field": "$.myField",
                  "Source Type": "Text",
                  "Source Regex": "",
                  "Source Format": "",
                  "Artifact Type": "",
                  "Artifact Role": "",
                  "Show Key Field": "",
                  "Sort Order": ""
              }
          ]
      },
      {
          "Event Source Name": "Event Source 2",
          "Data Copied": [
              {
                  "Field Name": "Action Results",
                  "Source Field": "$.mySourceField",
                  "Source Type": "Text",
                  "Source Regex": "",
                  "Source Format": "",
                  "Artifact Type": "",
                  "Artifact Role": "",
                  "Show Key Field": "",
                  "Sort Order": ""
              },
              {
                  "Field Name": "Action Results ID",
                  "Source Field": "$.myField",
                  "Source Type": "Text",
                  "Source Regex": "",
                  "Source Format": "",
                  "Artifact Type": "",
                  "Artifact Role": "",
                  "Show Key Field": "",
                  "Sort Order": ""
              }
          ]
      }
  ]
}